uidex 0.2.4 → 0.3.0

package/dist/core/index.d.cts

@@ -1,424 +0,0 @@
-type BorderStyle = 'solid' | 'dashed' | 'dotted';
-type LabelPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-type ButtonPosition = 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
-interface UidexDefaults {
-    color?: string;
-    borderStyle?: BorderStyle;
-    borderWidth?: number;
-}
-interface UidexConfig {
-    defaults?: UidexDefaults;
-    colors?: Record<string, string>;
-}
-type UidexKind = 'block' | 'component' | 'primitive';
-interface UidexLocation {
-    filePath: string;
-    line: number;
-    kind: UidexKind;
-    doc?: string;
-    scopes?: string[];
-}
-type UidexMap = Record<string, UidexLocation[]>;
-interface PrimitiveEntry {
-    name: string;
-    filePath: string;
-    scope: string;
-    composes: string[];
-    usedBy: string[];
-    kind: 'primitive';
-}
-interface UidexPage {
-    dir: string;
-    content: string;
-    description?: string;
-    componentIds: string[];
-    rootId?: string;
-}
-interface UidexFeature {
-    dir: string;
-    content: string;
-    description?: string;
-    componentIds: string[];
-}
-interface KeyboardShortcut {
-    key: string;
-    ctrlKey?: boolean;
-    shiftKey?: boolean;
-    altKey?: boolean;
-    metaKey?: boolean;
-}
-interface IngestConfig {
-    endpoint: string;
-    apiKey: string;
-    environment?: string;
-    appVersion?: string;
-    reporter?: {
-        email?: string;
-        name?: string;
-    };
-    metadata?: Record<string, string>;
-    captureConsole?: boolean;
-    captureNetwork?: boolean;
-}
-type FeedbackResult = {
-    ok: true;
-    id: string;
-    sequenceNumber: number;
-} | {
-    ok: false;
-    error: string;
-};
-type UidexTheme = 'dark' | 'light' | 'auto';
-interface UidexUIOptions {
-    components?: UidexMap;
-    pages?: UidexPage[];
-    features?: UidexFeature[];
-    uiComponents?: PrimitiveEntry[];
-    config?: UidexConfig;
-    buttonPosition?: ButtonPosition;
-    /** Theme for the devtools widget. Default: 'auto'. */
-    theme?: UidexTheme;
-    onSelect?: (id: string) => void;
-    /** Keyboard shortcut to toggle inspect mode. Set to false to disable. */
-    inspectShortcut?: KeyboardShortcut | false;
-    /** Ingest configuration for submitting feedback to a server. */
-    ingest?: IngestConfig;
-    /** Called after feedback submission with the report and result. */
-    onSubmit?: (report: FeedbackReport, result: FeedbackResult) => void;
-}
-type FeedbackType = 'bug' | 'feature' | 'improvement' | 'question';
-type FeedbackSeverity = 'low' | 'medium' | 'high' | 'critical';
-interface ConsoleLogEntry {
-    level: 'warn' | 'error';
-    message: string;
-    timestamp: string;
-}
-interface NetworkErrorEntry {
-    url: string;
-    method: string;
-    status: number | null;
-    statusText: string;
-    timestamp: string;
-}
-interface FeedbackReport {
-    type: FeedbackType;
-    severity: FeedbackSeverity;
-    title?: string;
-    description: string;
-    componentId: string;
-    element: string | null;
-    sources: {
-        filePath: string;
-        line: number;
-    }[];
-    url: string;
-    path: string;
-    route: string | null;
-    timestamp: string;
-    pageTitle: string;
-    pageDescription?: string;
-    locale: string;
-    sessionId: string;
-    viewport: {
-        width: number;
-        height: number;
-    };
-    screen: {
-        width: number;
-        height: number;
-    };
-    userAgent: string;
-    screenshot?: string;
-    reporterEmail?: string;
-    reporterName?: string;
-    environment?: string;
-    appVersion?: string;
-    metadata?: Record<string, string>;
-    consoleLogs?: ConsoleLogEntry[];
-    networkErrors?: NetworkErrorEntry[];
-    gitBranch?: string;
-    gitCommit?: string;
-    contextId?: string;
-}
-interface GitContext {
-    branch: string;
-    commit?: string;
-}
-interface OverlayOptions {
-    color?: string;
-    borderStyle?: BorderStyle;
-    borderWidth?: number;
-    colors?: Record<string, string>;
-    /** Outward padding in pixels — expands the overlay beyond the target rect. */
-    padding?: number;
-    /** Opacity of the overlay border (0–1). */
-    opacity?: number;
-    /** Opacity of the semi-transparent background fill (0–1). Default 0.08. */
-    fillOpacity?: number;
-}
-
-declare class UidexUI {
-    private menu;
-    private overlay;
-    private blockOverlay;
-    private modal;
-    private inspector;
-    private options;
-    private mounted;
-    private shadowHost;
-    private shadowRoot;
-    private themeWrapper;
-    private observer;
-    private refreshTimer;
-    private copyTimer;
-    private currentPresentIds;
-    private activeMode;
-    private sessionId;
-    private capture;
-    private theme;
-    private mediaQuery;
-    private boundMediaChange;
-    private classObserver;
-    private cursorTooltip;
-    private pinnedOverlays;
-    constructor(options?: UidexUIOptions);
-    mount(container?: HTMLElement): void;
-    /** Change the widget theme at runtime. */
-    setTheme(theme: UidexTheme): void;
-    private resolveAutoTheme;
-    private cleanupThemeListeners;
-    private applyTheme;
-    destroy(): void;
-    startInspect(): void;
-    stopInspect(): void;
-    isInspecting(): boolean;
-    /** Open the command palette. */
-    openCommand(): void;
-    /** Open the page dialog. */
-    openPage(dir?: string): void;
-    /** Cycle through inspect modes: inspect → copy → feedback → off. */
-    private cycleMode;
-    /** Set a specific inspect mode directly. */
-    private setMode;
-    private getComponentsMap;
-    private getPagesArray;
-    private getFeaturesArray;
-    private extractPageTitle;
-    /** Page button handler. */
-    private handlePageClick;
-    /** Match current URL pathname to a page dir. */
-    private matchCurrentRoute;
-    /** Format a page dir as a route by stripping prefix segments and route groups. */
-    private formatRoute;
-    /** Check if a route pattern matches a pathname, handling dynamic segments. */
-    private routeMatches;
-    /** Command button handler. */
-    private handleCommandClick;
-    /** Selection handler — routes by active mode. */
-    private handleSelect;
-    private clearPinnedOverlays;
-    private handleCopySelect;
-    private findElement;
-    private scrollAndHighlight;
-    private get overlayConfig();
-    private lastHighlightedElement;
-    private handleHighlight;
-    /** Detect which components live inside which blocks via DOM ancestry. */
-    private scanBlockContainment;
-    /** Push current pages/features/components/presentIds to the modal. */
-    private updateModalData;
-    /** Scan which registered component IDs are currently in the DOM. */
-    private scanPresentIds;
-    /** Schedule a debounced refresh of the modal data after DOM mutations. */
-    private scheduleRefresh;
-    /** Re-scan the DOM and update modal data if the set of present IDs changed. */
-    private refresh;
-    private startObserving;
-    private stopObserving;
-}
-declare function createUidexUI(options?: UidexUIOptions): UidexUI;
-
-type ActiveMode = 'inspect' | 'copy' | 'feedback' | null;
-interface MenuOptions {
-    onInspectCycle?: () => void;
-    onModeSelect?: (mode: 'inspect' | 'copy' | 'feedback' | null) => void;
-    onPageClick?: () => void;
-    onCommandClick?: () => void;
-}
-declare class Menu {
-    private host;
-    private root;
-    private options;
-    private activeMode;
-    private hasPages;
-    private positionClass;
-    private container;
-    constructor(options?: MenuOptions);
-    setPosition(position: ButtonPosition): void;
-    getContainer(): HTMLDivElement | null;
-    setActiveMode(mode: ActiveMode): void;
-    setHasPages(has: boolean): void;
-    setContainer(el: HTMLElement | null): void;
-    create(): HTMLDivElement;
-    destroy(): void;
-    private render;
-}
-
-type ModalPage = UidexPage & {
-    title: string;
-    description?: string;
-};
-type ModalFeature = UidexFeature & {
-    title: string;
-};
-interface ModalData {
-    pages: ModalPage[];
-    features: ModalFeature[];
-    components: UidexMap;
-    presentIds: Set<string>;
-    blockContainment: Map<string, string[]>;
-    uiComponents: Map<string, PrimitiveEntry>;
-}
-interface ModalOptions {
-    onComponentNavigate?: (id: string) => void;
-    onLocate?: (id: string) => void;
-    elementGetter?: (id: string) => Element | null;
-    ingest?: IngestConfig;
-    onSubmit?: (report: FeedbackReport, result: FeedbackResult) => void;
-    sessionId?: string;
-    getConsoleLogs?: () => ConsoleLogEntry[];
-    getNetworkErrors?: () => NetworkErrorEntry[];
-}
-
-declare class ModalManager {
-    private container;
-    private host;
-    private root;
-    private store;
-    private options;
-    constructor(options?: ModalOptions);
-    setContainer(el: HTMLElement): void;
-    setData(data: ModalData): void;
-    openCommand(): void;
-    openPage(dir?: string): void;
-    openComponent(id: string): void;
-    openUi(filePath: string): void;
-    openFeedback(id: string): void;
-    closeAll(): void;
-    isOpen(): boolean;
-    destroy(): void;
-    private ensureMounted;
-    private render;
-}
-
-declare class Overlay {
-    private element;
-    private target;
-    private baseOptions;
-    private options;
-    private boundUpdatePosition;
-    private rafId;
-    constructor(options?: OverlayOptions);
-    show(target: HTMLElement, overrides?: Partial<OverlayOptions>): void;
-    hide(): void;
-    destroy(): void;
-    updateOptions(options: Partial<OverlayOptions>): void;
-    private createElement;
-    private updateStyles;
-    private updatePosition;
-    private addListeners;
-    private removeListeners;
-}
-
-interface InspectorOptions {
-    shortcut?: KeyboardShortcut;
-    onHighlight?: (element: HTMLElement | null, id: string | null, parentBlock?: {
-        element: HTMLElement;
-        id: string;
-    } | null, cursor?: {
-        x: number;
-        y: number;
-    } | null) => void;
-    onSelect?: (element: HTMLElement, id: string, opts?: {
-        persistent?: boolean;
-    }) => void;
-    onActivate?: () => void;
-    onDeactivate?: () => void;
-}
-declare class Inspector {
-    private active;
-    private shortcut;
-    private currentTarget;
-    private onHighlight;
-    private onSelect;
-    private onActivate;
-    private onDeactivate;
-    private boundKeyDown;
-    private boundMouseMove;
-    private boundClick;
-    constructor(options?: InspectorOptions);
-    mount(): void;
-    destroy(): void;
-    activate(): void;
-    deactivate(): void;
-    isActive(): boolean;
-    private handleKeyDown;
-    private handleMouseMove;
-    private handleClick;
-}
-
-declare class CursorTooltip {
-    private element;
-    show(x: number, y: number, label: string, color: string): void;
-    hide(): void;
-    destroy(): void;
-    private createElement;
-}
-
-/**
- * Injects the uidex styles into a shadow root as a <style> element.
- * This isolates all uidex CSS from the host page.
- */
-declare function injectStyles(shadowRoot: ShadowRoot): void;
-
-declare function registerComponents(components: UidexMap): void;
-declare function getComponents(): UidexMap | null;
-declare function registerPages(pages: UidexPage[]): void;
-declare function getPages(): UidexPage[] | null;
-declare function registerFeatures(features: UidexFeature[]): void;
-declare function getFeatures(): UidexFeature[] | null;
-declare function registerGitContext(ctx: GitContext): void;
-declare function getGitContext(): GitContext | null;
-
-declare function classNames(...classes: (string | undefined | null | false)[]): string;
-declare function getContrastColor(hexColor: string): string;
-declare function hexToRgba(hex: string, alpha: number): string;
-declare function resolveColor(color: string | undefined, colorMap?: Record<string, string>): string | undefined;
-
-declare class IngestCapture {
-    private captureConsole;
-    private captureNetwork;
-    private consoleLogs;
-    private networkErrors;
-    private originalConsoleWarn;
-    private originalConsoleError;
-    private originalFetch;
-    constructor(captureConsole: boolean, captureNetwork: boolean);
-    start(): void;
-    stop(): void;
-    getConsoleLogs(): ConsoleLogEntry[];
-    getNetworkErrors(): NetworkErrorEntry[];
-    private interceptConsole;
-    private addConsoleLog;
-    private restoreConsole;
-    private interceptNetwork;
-    private addNetworkError;
-    private restoreNetwork;
-}
-declare function generateSessionId(): string;
-declare function submitFeedback(endpoint: string, apiKey: string, report: FeedbackReport): Promise<{
-    id: string;
-    sequenceNumber: number;
-}>;
-
-export { type BorderStyle, type ButtonPosition, type ConsoleLogEntry, CursorTooltip, type FeedbackReport, type FeedbackResult, type FeedbackSeverity, type FeedbackType, type GitContext, IngestCapture, type IngestConfig, Inspector, type KeyboardShortcut, type LabelPosition, Menu, ModalManager as Modal, type ModalData, type ModalFeature, ModalManager, type ModalOptions, type ModalPage, type NetworkErrorEntry, Overlay, type OverlayOptions, type PrimitiveEntry, type UidexConfig, type UidexDefaults, type UidexFeature, type UidexLocation, type UidexMap, type UidexPage, type UidexTheme, UidexUI, type UidexUIOptions, classNames, createUidexUI, generateSessionId, getComponents, getContrastColor, getFeatures, getGitContext, getPages, hexToRgba, injectStyles, registerComponents, registerFeatures, registerGitContext, registerPages, resolveColor, submitFeedback };