circuit-bricks/dist/registry/metadata.d.ts

A modular, Lego-style SVG circuit component system for React (ALPHA - Not for production use)

/**
 * Registry Metadata System for LLM Integration
 *
 * This module provides metadata about the component registry that helps
 * LLMs (Large Language Models) understand the available components,
 * their categories, and their capabilities.
 */
import { ComponentSchema } from '../schemas/componentSchema';
/**
 * Registry metadata interface
 */
export interface RegistryMetadata {
    /**
     * Total number of components in the registry
     */
    totalComponents: number;
    /**
     * List of all available component categories
     */
    categories: string[];
    /**
     * Map of category to component count
     */
    componentCountByCategory: Record<string, number>;
    /**
     * List of all component IDs
     */
    componentIds: string[];
    /**
     * Map of component ID to component name
     */
    componentNames: Record<string, string>;
    /**
     * Map of component ID to component description
     */
    componentDescriptions: Record<string, string>;
    /**
     * Last updated timestamp
     */
    lastUpdated: string;
}
/**
 * Generate metadata about the component registry
 *
 * This function analyzes the current state of the component registry
 * and generates metadata that can be used by LLMs to understand
 * what components are available.
 *
 * @returns Registry metadata object
 */
export declare function generateRegistryMetadata(): RegistryMetadata;
/**
 * Get a summary of a component for LLM consumption
 *
 * @param componentId The ID of the component to summarize
 * @returns A string summary of the component
 */
export declare function getComponentSummary(component: ComponentSchema): string;
/**
 * Generate a complete registry summary for LLM consumption
 *
 * @returns A string summary of the entire registry
 */
export declare function generateRegistrySummary(): string;
//# sourceMappingURL=metadata.d.ts.map