angular-grab 0.1.0

package/dist/core/index.d.ts

@@ -0,0 +1,139 @@
+type ThemeMode = 'dark' | 'light' | 'system';
+type PendingAction = {
+    type: 'copy-element';
+} | {
+    type: 'copy-styles';
+} | {
+    type: 'copy-html';
+} | {
+    type: 'comment';
+};
+/** Serializable subset of ElementContext — no live DOM reference. */
+interface HistoryContext {
+    html: string;
+    componentName: string | null;
+    filePath: string | null;
+    line: number | null;
+    column: number | null;
+    componentStack: ComponentStackEntry[];
+    selector: string;
+    cssClasses: string[];
+}
+interface HistoryEntry {
+    id: string;
+    context: HistoryContext;
+    snippet: string;
+    timestamp: number;
+}
+interface ToolbarState {
+    visible: boolean;
+    themeMode: ThemeMode;
+    history: HistoryEntry[];
+    pendingAction: PendingAction | null;
+}
+interface AngularGrabOptions {
+    /** Keyboard shortcut to activate. Default: "Meta+C" (Mac) / "Ctrl+C" (Win) */
+    activationKey: string;
+    /** Whether activation requires hold or toggle. Default: 'hold' */
+    activationMode: 'hold' | 'toggle';
+    /** Milliseconds to hold before activating in hold mode. Default: 0 */
+    keyHoldDuration: number;
+    /** Max lines of HTML to include in copied context. Default: 20 */
+    maxContextLines: number;
+    /** Master on/off switch. Default: true */
+    enabled: boolean;
+    /** Allow activation while focused in input/textarea. Default: false */
+    enableInInputs: boolean;
+    /** Only activate in dev mode. Default: true */
+    devOnly: boolean;
+    /** Show the floating mini toolbar. Default: true */
+    showToolbar: boolean;
+    /** Theme mode for all UI. Default: 'dark' */
+    themeMode: ThemeMode;
+}
+interface ComponentStackEntry {
+    name: string;
+    filePath: string | null;
+    line: number | null;
+    column: number | null;
+}
+interface ElementContext {
+    element: Element;
+    html: string;
+    componentName: string | null;
+    filePath: string | null;
+    line: number | null;
+    column: number | null;
+    componentStack: ComponentStackEntry[];
+    selector: string;
+    cssClasses: string[];
+}
+interface PluginHooks {
+    onActivate?: () => void;
+    onDeactivate?: () => void;
+    onElementHover?: (element: Element) => void;
+    onElementSelect?: (context: ElementContext) => void;
+    onBeforeCopy?: (context: ElementContext) => void;
+    onCopySuccess?: (text: string, context: ElementContext, prompt?: string) => void;
+    onCopyError?: (error: Error) => void;
+    transformCopyContent?: (text: string, context: ElementContext) => string;
+}
+interface Theme {
+    overlayBorderColor: string;
+    overlayBgColor: string;
+    labelBgColor: string;
+    labelTextColor: string;
+    toastBgColor: string;
+    toastTextColor: string;
+    toolbarBgColor: string;
+    toolbarTextColor: string;
+    toolbarAccentColor: string;
+    popoverBgColor: string;
+    popoverTextColor: string;
+    popoverBorderColor: string;
+}
+interface Plugin {
+    name: string;
+    hooks?: PluginHooks;
+    theme?: Partial<Theme>;
+    options?: Partial<AngularGrabOptions>;
+    setup?: (api: AngularGrabAPI) => PluginCleanup | void;
+}
+type PluginCleanup = () => void;
+type ComponentResolver = (element: Element) => {
+    name: string | null;
+    hostElement: Element | null;
+    stack?: Array<{
+        name: string;
+        hostElement: Element | null;
+    }>;
+} | null;
+type SourceResolver = (element: Element) => {
+    filePath: string | null;
+    line: number | null;
+    column: number | null;
+} | null;
+interface AngularGrabAPI {
+    activate(): void;
+    deactivate(): void;
+    toggle(): void;
+    isActive(): boolean;
+    setOptions(opts: Partial<AngularGrabOptions>): void;
+    registerPlugin(plugin: Plugin): void;
+    unregisterPlugin(name: string): void;
+    setComponentResolver(resolver: ComponentResolver): void;
+    setSourceResolver(resolver: SourceResolver): void;
+    showToolbar(): void;
+    hideToolbar(): void;
+    setThemeMode(mode: ThemeMode): void;
+    getHistory(): HistoryEntry[];
+    clearHistory(): void;
+    dispose(): void;
+}
+
+declare function init(options?: Partial<AngularGrabOptions>): AngularGrabAPI;
+declare function createGrabInstance(options?: Partial<AngularGrabOptions>): AngularGrabAPI;
+
+declare function filterAngularClasses(classList: DOMTokenList): string[];
+
+export { type AngularGrabAPI, type AngularGrabOptions, type ComponentResolver, type ComponentStackEntry, type ElementContext, type HistoryContext, type HistoryEntry, type PendingAction, type Plugin, type PluginCleanup, type PluginHooks, type SourceResolver, type Theme, type ThemeMode, type ToolbarState, createGrabInstance, filterAngularClasses, init };