uidex 0.1.1 → 0.2.1

package/dist/core/index.d.cts

@@ -35,6 +35,27 @@ interface KeyboardShortcut {
     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[];
@@ -44,6 +65,60 @@ interface UidexUIOptions {
     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;
@@ -88,6 +163,11 @@ interface ModalData {
 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;
@@ -187,6 +267,8 @@ declare class UidexUI {
     private copyTimer;
     private currentPresentIds;
     private activeMode;
+    private sessionId;
+    private capture;
     constructor(options?: UidexUIOptions);
     mount(container?: HTMLElement): void;
     destroy(): void;
@@ -277,6 +359,8 @@ declare class Overlay {
     private updateLabel;
     private applyLabelPosition;
     private updatePosition;
+    /** Move the label inside the overlay when there is no room outside. */
+    private clampLabel;
     private addListeners;
     private removeListeners;
 }
@@ -328,4 +412,30 @@ 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;
 
-export { type BorderStyle, type ButtonPosition, Inspector, type KeyboardShortcut, type LabelPosition, Menu, Modal, type ModalView, Overlay, type OverlayOptions, type UidexConfig, type UidexDefaults, type UidexFeature, type UidexLocation, type UidexMap, type UidexPage, UidexUI, type UidexUIOptions, classNames, createUidexUI, getComponents, getContrastColor, getFeatures, getPages, hexToRgba, injectStyles, registerComponents, registerFeatures, registerPages, resolveColor };
+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 };

package/dist/core/index.d.ts

@@ -35,6 +35,27 @@ interface KeyboardShortcut {
     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[];
@@ -44,6 +65,60 @@ interface UidexUIOptions {
     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;
@@ -88,6 +163,11 @@ interface ModalData {
 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;
@@ -187,6 +267,8 @@ declare class UidexUI {
     private copyTimer;
     private currentPresentIds;
     private activeMode;
+    private sessionId;
+    private capture;
     constructor(options?: UidexUIOptions);
     mount(container?: HTMLElement): void;
     destroy(): void;
@@ -277,6 +359,8 @@ declare class Overlay {
     private updateLabel;
     private applyLabelPosition;
     private updatePosition;
+    /** Move the label inside the overlay when there is no room outside. */
+    private clampLabel;
     private addListeners;
     private removeListeners;
 }
@@ -328,4 +412,30 @@ 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;
 
-export { type BorderStyle, type ButtonPosition, Inspector, type KeyboardShortcut, type LabelPosition, Menu, Modal, type ModalView, Overlay, type OverlayOptions, type UidexConfig, type UidexDefaults, type UidexFeature, type UidexLocation, type UidexMap, type UidexPage, UidexUI, type UidexUIOptions, classNames, createUidexUI, getComponents, getContrastColor, getFeatures, getPages, hexToRgba, injectStyles, registerComponents, registerFeatures, registerPages, resolveColor };
+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 };