@blqke/vgentation 0.1.0

package/dist/utils/vue-detection.d.ts

@@ -0,0 +1,78 @@
+import { SourceLocation } from './devtools-integration';
+/**
+ * Vue component instance interface (partial, for detection purposes)
+ */
+interface VueComponentInstance {
+    $?: {
+        type?: {
+            name?: string;
+            __name?: string;
+            __file?: string;
+        };
+        parent?: VueComponentInstance['$'];
+        props?: Record<string, unknown>;
+        setupState?: Record<string, unknown>;
+    };
+    type?: {
+        name?: string;
+        __name?: string;
+        __file?: string;
+    };
+    parent?: VueComponentInstance;
+    props?: Record<string, unknown>;
+    setupState?: Record<string, unknown>;
+}
+export interface VueComponentInfo {
+    name: string;
+    filePath?: string;
+    props?: Record<string, unknown>;
+    sourceLocation?: SourceLocation;
+    isPage?: boolean;
+    isLayout?: boolean;
+}
+export interface VueDetectionResult {
+    component?: VueComponentInfo;
+    componentPath?: string;
+    componentTree?: VueComponentInfo[];
+    sourceLocation?: SourceLocation;
+    devToolsEnhanced?: boolean;
+}
+/**
+ * Check if Vue devtools mode is available (component info accessible)
+ */
+export declare function isVueDevMode(): boolean;
+/**
+ * Get Vue component instance from a DOM element
+ */
+export declare function getVueInstance(element: HTMLElement): VueComponentInstance | null;
+/**
+ * Extract component name from a Vue instance
+ * Uses DevTools-enhanced naming when available for better accuracy
+ */
+export declare function getComponentName(instance: VueComponentInstance): string | null;
+/**
+ * Extract file path from a Vue instance
+ * Tries multiple sources to find the file path
+ */
+export declare function getComponentFilePath(instance: VueComponentInstance): string | null;
+/**
+ * Get props from a Vue instance (sanitized for display)
+ */
+export declare function getComponentProps(instance: VueComponentInstance): Record<string, unknown> | null;
+/**
+ * Get parent Vue component instance
+ */
+export declare function getParentComponent(instance: VueComponentInstance): VueComponentInstance | null;
+/**
+ * Build component tree from element to root
+ */
+export declare function buildComponentTree(element: HTMLElement): VueComponentInfo[];
+/**
+ * Main detection function - gets Vue context for an element
+ */
+export declare function detectVueContext(element: HTMLElement): VueDetectionResult;
+/**
+ * Find the closest Vue component for an element
+ */
+export declare function findClosestComponent(element: HTMLElement): VueComponentInfo | null;
+export {};