uidex 0.2.1 → 0.3.0

package/dist/core/index.d.ts

@@ -1,441 +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;
-    showLabel?: boolean;
-    labelPosition?: LabelPosition;
-}
-interface UidexConfig {
-    defaults?: UidexDefaults;
-    colors?: Record<string, string>;
-}
-interface UidexLocation {
-    filePath: string;
-    line: number;
-    doc?: string;
-}
-type UidexMap = Record<string, UidexLocation[]>;
-interface UidexPage {
-    dir: string;
-    content: string;
-    componentIds: string[];
-}
-interface UidexFeature {
-    dir: string;
-    content: 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;
-};
-interface UidexUIOptions {
-    components?: UidexMap;
-    pages?: UidexPage[];
-    features?: UidexFeature[];
-    config?: UidexConfig;
-    buttonPosition?: ButtonPosition;
-    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;
-    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[];
-}
-interface OverlayOptions {
-    color?: string;
-    borderStyle?: BorderStyle;
-    borderWidth?: number;
-    label?: string;
-    showLabel?: boolean;
-    labelPosition?: LabelPosition;
-    colors?: Record<string, string>;
-}
-
-type ModalView = {
-    type: 'page';
-    dir: string;
-} | {
-    type: 'feature';
-    dir: string;
-} | {
-    type: 'component';
-    id: string;
-} | {
-    type: 'graph';
-};
-interface ModalPage {
-    title: string;
-    dir: string;
-    content: string;
-    componentIds: string[];
-}
-interface ModalFeature {
-    title: string;
-    dir: string;
-    content: string;
-    componentIds: string[];
-}
-interface ModalData {
-    pages: ModalPage[];
-    features: ModalFeature[];
-    components: UidexMap;
-    presentIds: Set<string>;
-}
-interface ModalOptions {
-    onComponentNavigate?: (id: string) => void;
-    elementGetter?: (id: string) => Element | null;
-    ingest?: IngestConfig;
-    onSubmit?: (report: FeedbackReport, result: FeedbackResult) => void;
-    sessionId?: string;
-    getConsoleLogs?: () => ConsoleLogEntry[];
-    getNetworkErrors?: () => NetworkErrorEntry[];
-}
-declare class Modal {
-    private backdrop;
-    private sidebar;
-    private mainContent;
-    private renderTarget;
-    private boundKeyDown;
-    private data;
-    private currentView;
-    private modalType;
-    private sidebarLevel;
-    private expandedGroups;
-    private searchQuery;
-    private searchInput;
-    private options;
-    private static readonly VIEW_TYPE_TO_LEVEL;
-    /** Strip the scanner root dir (e.g. "app") so pages display as routes: app → /, app/foo → /foo */
-    private static formatPageDir;
-    constructor(options?: ModalOptions);
-    /** Set the shadow root to render modals into. */
-    setShadowRoot(root: ShadowRoot): void;
-    /** Update the data model. Refreshes sidebar and content if modal is open. */
-    setData(data: ModalData): void;
-    /** Open the modal. If already open, navigates to the given view. */
-    open(view?: ModalView): void;
-    /** Navigate to a view within the open modal. */
-    navigateTo(view: ModalView): void;
-    hide(): void;
-    destroy(): void;
-    isOpen(): boolean;
-    private getDefaultView;
-    /**
-     * Create the shared modal frame: backdrop, dialog, header (title + close), and mount.
-     * Returns the dialog and header elements so callers can append extra header/body content.
-     */
-    private createModalFrame;
-    /** Finalize modal frame: append close button to header, header to dialog, mount to DOM. */
-    private mountModalFrame;
-    private createShell;
-    private renderSidebar;
-    private renderSidebarRoot;
-    private renderSidebarSublevel;
-    private currentViewMatchesLevel;
-    private getFirstViewForLevel;
-    private getComponentPrefix;
-    private groupComponentsByPrefix;
-    private createSidebarItem;
-    private updateSidebarActive;
-    private getSearchResults;
-    private renderSearchResults;
-    private renderMainContent;
-    private renderPageView;
-    private renderFeatureView;
-    private renderComponentView;
-    private renderGraphView;
-    /** Open a dedicated feedback modal for a specific component. */
-    openFeedback(id: string): void;
-    private createFeedbackShell;
-    /** Render component context (features, pages, doc) above the feedback form. */
-    private renderFeedbackContext;
-    private createChipContainer;
-    private renderFeedbackFormContent;
-    private createComponentChip;
-    private createFeatureChipsSection;
-    private createComponentChipsSection;
-    private createFormGroup;
-    private createSelect;
-    private createChecklistItem;
-    private renderMarkdown;
-    /**
-     * Capture an element by cloning it with inlined computed styles into an
-     * SVG foreignObject, rendering to canvas via an <img> data-URI, and
-     * returning a PNG data-URL.
-     */
-    private captureElementScreenshot;
-    /** Visual CSS properties worth inlining for a screenshot clone. */
-    private static readonly VISUAL_PROPS;
-    /** Recursively copy visual computed styles from source onto a cloned target. */
-    private inlineComputedStyles;
-    private collectEnv;
-    private getBrowserName;
-    private describeElement;
-    private handleKeyDown;
-}
-
-declare class UidexUI {
-    private menu;
-    private overlay;
-    private modal;
-    private inspector;
-    private options;
-    private mounted;
-    private shadowHost;
-    private shadowRoot;
-    private observer;
-    private refreshTimer;
-    private copyTimer;
-    private currentPresentIds;
-    private activeMode;
-    private sessionId;
-    private capture;
-    constructor(options?: UidexUIOptions);
-    mount(container?: HTMLElement): void;
-    destroy(): void;
-    startInspect(): void;
-    stopInspect(): void;
-    isInspecting(): boolean;
-    /** Open the modal panel, optionally to a specific view. */
-    openPanel(view?: ModalView): void;
-    private toggleMode;
-    private updateMenuActiveStates;
-    private getComponentsMap;
-    private getPagesArray;
-    private getFeaturesArray;
-    private extractPageTitle;
-    /** Hamburger button handler — open modal to default (current page) view. */
-    private handleExpandClick;
-    /** Selection handler — routes by active mode. */
-    private handleSelect;
-    private handleCopySelect;
-    private findElement;
-    private handleHighlight;
-    /** 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;
-
-interface MenuOptions {
-    onInspectToggle?: () => void;
-    onCopyToggle?: () => void;
-    onFeedbackToggle?: () => void;
-    onExpandClick?: () => void;
-}
-declare class Menu {
-    private container;
-    private group;
-    private expandBtn;
-    private inspectBtn;
-    private copyBtn;
-    private feedbackBtn;
-    private options;
-    private isDragging;
-    private dragStartX;
-    private dragStartY;
-    private dragStartLeft;
-    private dragStartTop;
-    private hasDragged;
-    private boundPointerDown;
-    private boundPointerMove;
-    private boundPointerUp;
-    constructor(options?: MenuOptions);
-    getContainer(): HTMLDivElement | null;
-    /** Update a button's active state. */
-    private setButtonActive;
-    setInspectActive(active: boolean): void;
-    setCopyActive(active: boolean): void;
-    setFeedbackActive(active: boolean): void;
-    private createButton;
-    create(): HTMLDivElement;
-    destroy(): void;
-    private handlePointerDown;
-    private handlePointerMove;
-    private handlePointerUp;
-    private snapToCorner;
-}
-
-declare class Overlay {
-    private element;
-    private labelElement;
-    private target;
-    private options;
-    private boundUpdatePosition;
-    private rafId;
-    constructor(options?: OverlayOptions);
-    show(target: HTMLElement, label?: string): void;
-    hide(): void;
-    destroy(): void;
-    updateOptions(options: Partial<OverlayOptions>): void;
-    private createElement;
-    private updateStyles;
-    private updateLabel;
-    private applyLabelPosition;
-    private updatePosition;
-    /** Move the label inside the overlay when there is no room outside. */
-    private clampLabel;
-    private addListeners;
-    private removeListeners;
-}
-
-interface InspectorOptions {
-    shortcut?: KeyboardShortcut;
-    onHighlight?: (element: HTMLElement | null, id: string | null) => void;
-    onSelect?: (element: HTMLElement, id: string) => 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;
-}
-
-/**
- * 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 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, type FeedbackReport, type FeedbackResult, type FeedbackSeverity, type FeedbackType, IngestCapture, type IngestConfig, Inspector, type KeyboardShortcut, type LabelPosition, Menu, Modal, type ModalView, type NetworkErrorEntry, Overlay, type OverlayOptions, type UidexConfig, type UidexDefaults, type UidexFeature, type UidexLocation, type UidexMap, type UidexPage, UidexUI, type UidexUIOptions, classNames, createUidexUI, generateSessionId, getComponents, getContrastColor, getFeatures, getPages, hexToRgba, injectStyles, registerComponents, registerFeatures, registerPages, resolveColor, submitFeedback };