circuit-bricks
Version:
A modular, Lego-style SVG circuit component system for React (ALPHA - Not for production use)
41 lines • 1.45 kB
TypeScript
/**
* Component Discovery API for LLM Integration
*
* This module provides functions that allow LLMs to discover and understand
* what components are available in the circuit-bricks registry.
*/
import { ComponentInfo, ComponentSearchResult } from './types';
/**
* List all available components in a format optimized for LLM consumption
*
* @returns Array of simplified component information
*/
export declare function listAvailableComponents(): ComponentInfo[];
/**
* Get detailed information about a specific component
*
* @param componentId - The ID of the component to get details for
* @returns Detailed component information or null if not found
*/
export declare function getComponentDetails(componentId: string): ComponentInfo | null;
/**
* Search components by name, description, or category
*
* @param query - Search query string
* @returns Array of search results with relevance scores
*/
export declare function searchComponents(query: string): ComponentSearchResult[];
/**
* Get all unique categories available in the registry
*
* @returns Array of category names
*/
export declare function getAllCategories(): string[];
/**
* List components in a specific category
*
* @param category - The category to filter by
* @returns Array of components in the specified category
*/
export declare function listComponentsByCategory(category: string): ComponentInfo[];
//# sourceMappingURL=componentDiscovery.d.ts.map