fixdog 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,158 @@
+type ElementInfoKind = "source" | "dom";
+interface DomSnapshot {
+    outerHTML: string;
+    text: string;
+    attributes: Record<string, string>;
+}
+interface ElementInfo {
+    kind: ElementInfoKind;
+    componentName?: string;
+    filePath?: string;
+    line?: number;
+    column?: number;
+    domSnapshot?: DomSnapshot;
+    box?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+interface SourceLocation {
+    fileName: string;
+    lineNumber: number;
+    columnNumber: number;
+    functionName?: string;
+}
+type EditorType = "vscode" | "vscode-insiders" | "cursor" | "webstorm" | "atom" | "sublime";
+interface UiDogNextOptions {
+    /**
+     * Editor to open when clicking elements
+     * @default 'cursor'
+     */
+    editor?: EditorType;
+    /**
+     * Project root path for resolving file paths
+     */
+    projectPath?: string;
+    /**
+     * Modifier key for element selection
+     * @default 'alt'
+     */
+    modifier?: "alt" | "ctrl" | "meta" | "shift";
+    /**
+     * Enable sidebar mode
+     * @default true
+     */
+    enableSidebar?: boolean;
+    /**
+     * API endpoint for edit requests
+     * @default 'https://api.ui.dog'
+     */
+    apiEndpoint?: string;
+}
+interface SidebarConfig {
+    apiEndpoint: string;
+}
+interface EditRequest {
+    editorUrl: string;
+    userInput: string;
+    /**
+     * Optional metadata to help when source is unavailable (e.g., server components)
+     */
+    elementKind?: ElementInfoKind;
+    domSnapshot?: DomSnapshot;
+}
+interface EditResponse {
+    sessionId: string;
+    message: string;
+    status: "success" | "error";
+    error?: string;
+}
+declare global {
+    interface Window {
+        __UIDOG_NEXT_INITIALIZED__?: boolean;
+        __UIDOG_SIDEBAR__?: {
+            isOpen: boolean;
+            elementInfo: ElementInfo | null;
+            editorUrl: string | null;
+        };
+    }
+}
+
+/**
+ * Source resolver - builds editor URLs from source location information
+ */
+
+/**
+ * Build an editor URL from source location information
+ */
+declare function buildEditorUrl(source: SourceLocation, editor?: EditorType, projectPath?: string): string;
+/**
+ * Normalize file name by removing bundler prefixes and query strings
+ */
+declare function normalizeFileName(fileName: string): string;
+/**
+ * Get the file name without path for display
+ */
+declare function getShortFileName(filePath: string): string;
+
+/**
+ * Sidebar initializer - mounts the UiDog sidebar in a shadow DOM for style isolation
+ */
+
+/**
+ * Open the sidebar with element information
+ */
+declare function openSidebar(elementInfo: ElementInfo, editorUrl: string): void;
+/**
+ * Close the sidebar
+ */
+declare function closeSidebar(): void;
+
+/**
+ * Bippy instrumentation setup for React fiber inspection
+ *
+ * Bippy hooks into React's DevTools API (window.__REACT_DEVTOOLS_GLOBAL_HOOK__)
+ * to intercept fiber tree data and extract source location information.
+ */
+
+/**
+ * Setup Bippy instrumentation to hook into React's internals
+ * This must be called BEFORE React loads (via instrumentation-client.ts)
+ */
+declare function setupBippyInstrumentation(): void;
+/**
+ * Get source location from a DOM element by traversing its React fiber
+ */
+declare function getSourceFromElement(element: Element): Promise<SourceLocation | null>;
+/**
+ * Get component name from a fiber
+ */
+declare function getComponentNameFromFiber(fiber: any): string;
+
+/**
+ * UiDog SDK for Next.js - Main entry point
+ *
+ * Uses Bippy to hook into React's internals for element source detection,
+ * providing a seamless developer experience for inspecting component locations.
+ */
+
+/**
+ * Initialize UiDog for Next.js
+ *
+ * This function sets up Bippy instrumentation, element detection, and the sidebar UI.
+ * It should be called early in your application's lifecycle, ideally via
+ * instrumentation-client.ts (Next.js 15.3+) or at the top of _app.tsx.
+ */
+declare function initializeUiDogNext(options?: UiDogNextOptions): void;
+/**
+ * Cleanup UiDog - removes all event listeners and UI
+ */
+declare function cleanupUiDogNext(): void;
+/**
+ * Check if UiDog is initialized
+ */
+declare function isUiDogNextInitialized(): boolean;
+
+export { EditRequest, EditResponse, EditorType, ElementInfo, SidebarConfig, SourceLocation, UiDogNextOptions, buildEditorUrl, cleanupUiDogNext, closeSidebar, getComponentNameFromFiber, getShortFileName, getSourceFromElement, initializeUiDogNext, isUiDogNextInitialized, normalizeFileName, openSidebar, setupBippyInstrumentation };

package/dist/index.d.ts

@@ -0,0 +1,158 @@
+type ElementInfoKind = "source" | "dom";
+interface DomSnapshot {
+    outerHTML: string;
+    text: string;
+    attributes: Record<string, string>;
+}
+interface ElementInfo {
+    kind: ElementInfoKind;
+    componentName?: string;
+    filePath?: string;
+    line?: number;
+    column?: number;
+    domSnapshot?: DomSnapshot;
+    box?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+interface SourceLocation {
+    fileName: string;
+    lineNumber: number;
+    columnNumber: number;
+    functionName?: string;
+}
+type EditorType = "vscode" | "vscode-insiders" | "cursor" | "webstorm" | "atom" | "sublime";
+interface UiDogNextOptions {
+    /**
+     * Editor to open when clicking elements
+     * @default 'cursor'
+     */
+    editor?: EditorType;
+    /**
+     * Project root path for resolving file paths
+     */
+    projectPath?: string;
+    /**
+     * Modifier key for element selection
+     * @default 'alt'
+     */
+    modifier?: "alt" | "ctrl" | "meta" | "shift";
+    /**
+     * Enable sidebar mode
+     * @default true
+     */
+    enableSidebar?: boolean;
+    /**
+     * API endpoint for edit requests
+     * @default 'https://api.ui.dog'
+     */
+    apiEndpoint?: string;
+}
+interface SidebarConfig {
+    apiEndpoint: string;
+}
+interface EditRequest {
+    editorUrl: string;
+    userInput: string;
+    /**
+     * Optional metadata to help when source is unavailable (e.g., server components)
+     */
+    elementKind?: ElementInfoKind;
+    domSnapshot?: DomSnapshot;
+}
+interface EditResponse {
+    sessionId: string;
+    message: string;
+    status: "success" | "error";
+    error?: string;
+}
+declare global {
+    interface Window {
+        __UIDOG_NEXT_INITIALIZED__?: boolean;
+        __UIDOG_SIDEBAR__?: {
+            isOpen: boolean;
+            elementInfo: ElementInfo | null;
+            editorUrl: string | null;
+        };
+    }
+}
+
+/**
+ * Source resolver - builds editor URLs from source location information
+ */
+
+/**
+ * Build an editor URL from source location information
+ */
+declare function buildEditorUrl(source: SourceLocation, editor?: EditorType, projectPath?: string): string;
+/**
+ * Normalize file name by removing bundler prefixes and query strings
+ */
+declare function normalizeFileName(fileName: string): string;
+/**
+ * Get the file name without path for display
+ */
+declare function getShortFileName(filePath: string): string;
+
+/**
+ * Sidebar initializer - mounts the UiDog sidebar in a shadow DOM for style isolation
+ */
+
+/**
+ * Open the sidebar with element information
+ */
+declare function openSidebar(elementInfo: ElementInfo, editorUrl: string): void;
+/**
+ * Close the sidebar
+ */
+declare function closeSidebar(): void;
+
+/**
+ * Bippy instrumentation setup for React fiber inspection
+ *
+ * Bippy hooks into React's DevTools API (window.__REACT_DEVTOOLS_GLOBAL_HOOK__)
+ * to intercept fiber tree data and extract source location information.
+ */
+
+/**
+ * Setup Bippy instrumentation to hook into React's internals
+ * This must be called BEFORE React loads (via instrumentation-client.ts)
+ */
+declare function setupBippyInstrumentation(): void;
+/**
+ * Get source location from a DOM element by traversing its React fiber
+ */
+declare function getSourceFromElement(element: Element): Promise<SourceLocation | null>;
+/**
+ * Get component name from a fiber
+ */
+declare function getComponentNameFromFiber(fiber: any): string;
+
+/**
+ * UiDog SDK for Next.js - Main entry point
+ *
+ * Uses Bippy to hook into React's internals for element source detection,
+ * providing a seamless developer experience for inspecting component locations.
+ */
+
+/**
+ * Initialize UiDog for Next.js
+ *
+ * This function sets up Bippy instrumentation, element detection, and the sidebar UI.
+ * It should be called early in your application's lifecycle, ideally via
+ * instrumentation-client.ts (Next.js 15.3+) or at the top of _app.tsx.
+ */
+declare function initializeUiDogNext(options?: UiDogNextOptions): void;
+/**
+ * Cleanup UiDog - removes all event listeners and UI
+ */
+declare function cleanupUiDogNext(): void;
+/**
+ * Check if UiDog is initialized
+ */
+declare function isUiDogNextInitialized(): boolean;
+
+export { EditRequest, EditResponse, EditorType, ElementInfo, SidebarConfig, SourceLocation, UiDogNextOptions, buildEditorUrl, cleanupUiDogNext, closeSidebar, getComponentNameFromFiber, getShortFileName, getSourceFromElement, initializeUiDogNext, isUiDogNextInitialized, normalizeFileName, openSidebar, setupBippyInstrumentation };