docs: params/output semántico en 506 funciones para composabilidad

Añade campos params y output al frontmatter YAML de las 506 funciones del registry. Cada parámetro tiene descripción semántica (qué representa, unidades, rango típico) y cada función describe qué produce su output. Permite a agentes razonar sobre cadenas de composición (ej: prices → log_return → sharpe_ratio) sin leer código.
2026-04-05 18:45:16 +02:00
parent bd1bf2b5dc
commit 988e901066
506 changed files with 2964 additions and 0 deletions
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+params:
+  - name: index
+    desc: "Índice cíclico en la paleta de colores (ciclará sobre 5 colores disponibles)"
+output: "String con variable CSS de color para gráficos (ej: 'hsl(var(--chart-1, 220 70% 50%))')"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [clsx, tailwind-merge]
+params:
+  - name: inputs
+    desc: "Clases CSS en cualquier formato: strings, arrays, objetos con condiciones booleanas"
+output: "String con clases CSS combinadas y mergeadas, sin duplicados y conflictos Tailwind resueltos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,12 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+params:
+  - name: "n"
+    desc: "Número a formatear de forma compacta"
+  - name: decimals
+    desc: "Cantidad de decimales a mostrar (por defecto 1)"
+output: "String con número formateado en notación compacta (ej: '1.2K', '1.5M', '1.0G')"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,12 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+params:
+  - name: colors
+    desc: "Objeto con pares clave-valor de nombre variable CSS a valor de color"
+  - name: selector
+    desc: "Selector CSS donde inyectar variables (':root' por defecto)"
+output: "String con bloque CSS completo conteniendo definiciones de variables de tema"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: "error_go_core"
 imports: []
+params:
+  - name: cssVar
+    desc: "Variable CSS a resolver (acepta '--primary', 'primary' o 'var(--primary)')"
+output: "String con valor RGB computado por el browser (ej: 'rgb(120, 80, 220)')"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,12 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+params:
+  - name: index
+    desc: "Índice de serie (ciclará sobre paleta de 5 colores)"
+  - name: color
+    desc: "Color explícito a usar si se proporciona (opcional)"
+output: "String con color HEX o el color explícito proporcionado"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: "error_go_core"
 imports: []
+output: "Objeto ThemeTokens con todas las variables CSS de tema resueltas (colores, tipografía, espaciado)"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+params:
+  - name: config
+    desc: "Configuración de tema con propiedades semánticas de color"
+output: "Objeto ThemeColors con variables CSS estandarizadas mapeadas de la config"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+output: "Clase WailsCache con métodos get, set, invalidate, subscribe para gestionar caché reactiva con invalidación jerárquica"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/collapsible", "lucide-react"]
+output: "Componente Accordion que renderiza secciones colapsables con soporte para múltiples items abiertos simultáneamente"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react, class-variance-authority]
+output: "Componente Alert que renderiza una alerta accesible con slots para título, descripción, icono y acción"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: props
+    desc: "Configuración del dashboard: título, métricas con deltas, y lista de charts con span"
+output: "Componente ReactElement que renderiza un dashboard de analytics completo con header, KPIs y grid de charts"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: "error_go_core"
 imports: []
+params:
+  - name: theme
+    desc: "Objeto Theme con nombre, label y colores a inyectar como CSS variables"
+output: "Void - función impura que inyecta CSS variables en document.documentElement"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [recharts]
+output: "Componente JSX que renderiza un gráfico de área con gradientes, multi-series y tooltips temáticos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["class-variance-authority"]
+output: "Componente Avatar que renderiza imagen de usuario circular con fallback a iniciales generadas"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["class-variance-authority"]
+output: "Componente Badge que renderiza un indicador visual con 10 variantes semánticas de estado"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [recharts]
+output: "Componente JSX que renderiza un gráfico de barras vertical u horizontal con multi-series y tooltips temáticos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["lucide-react"]
+output: "Componente Breadcrumb que renderiza navegación jerárquica con separadores, elipsis y soporte para router links"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react", "class-variance-authority"]
+output: "JSX.Element: botón renderizado con los estilos y comportamientos configurados"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["react"]
+output: "Componente Card que renderiza un contenedor con slots composables (header, content, footer) y 3 variantes visuales"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [recharts, react]
+output: "Componente ChartContainer que renderiza base responsive para gráficos Recharts con tooltip y legend temáticos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/checkbox", "class-variance-authority"]
+output: "Componente Checkbox que renderiza input booleano accesible con label opcional y estado indeterminate"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["lucide-react"]
+output: "Componente Command que renderiza combobox de búsqueda y selección con filtrado reactivo, grupos e iconos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: props
+    desc: "Configuración CRUD: título, datos, columnas de tabla, campos de formulario y callbacks para add/edit/delete"
+output: "Componente ReactElement que renderiza página CRUD completa con tabla y botones de acción"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: props
+    desc: "Configuración de layout: número de columnas y array de widgets con id, título, contenido y span"
+output: "Componente ReactElement que renderiza grid responsive de dashboard con ancho adaptable por widget"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente DataTable que renderiza tabla con sticky header, heatmap condicional y formato automático de datos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: props
+    desc: "Configuración de página de detalle: título, avatar, badge, tabs, timeline y campos de metadata"
+output: "Componente ReactElement que renderiza página de detalle con header, grid de campos y timeline de actividad"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react", lucide-react, react]
+output: "Componente Dialog que renderiza modal accesible con overlay blur, focus trap y sistema de slots composables"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/menu", "lucide-react"]
+output: "Componente DropdownMenu que renderiza menú desplegable accesible con items, checkboxes, radios y submenus"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente FormField que renderiza wrapper de campo con label, helper text, error y ARIA automáticos"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["graphology", "graphology-layout-forceatlas2", "sigma"]
+output: "Componente GraphContainer que renderiza grafo interactivo con sigma.js, ForceAtlas2 layout y legend"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react", "react"]
+output: "Componente Input que renderiza campo de entrada accesible con soporte para iconos y validación ARIA"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente KPICard que renderiza card de métrica con label, valor, delta descriptivo, icono y slot de mini chart"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["react"]
+output: "Componente Label que renderiza etiqueta de formulario accesible con soporte para estados disabled"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [recharts]
+output: "Componente LineChart que renderiza gráfico de líneas multi-series con zoom, curvas customizables y líneas de referencia"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente PageHeader que renderiza cabecera de página con título, acciones, tabs integrados y modo sticky"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["lucide-react", "./button"]
+output: "Componente Pagination que renderiza controles de navegación de páginas con Previous/Next y números"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [recharts]
+output: "Componente PieChart que renderiza gráfico de torta o dona con labels de porcentaje, leyenda y tooltip"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/popover"]
+output: "Componente Popover que renderiza contenido flotante accesible posicionado automáticamente"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [class-variance-authority]
+output: "Componente ProgressBar que renderiza barra de progreso con animaciones, buffer y modo indeterminado"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/radio-group", "@base-ui/react/radio"]
+output: "Componente RadioGroup que renderiza grupo de opciones exclusivas accesible"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,14 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["lucide-react"]
+params:
+  - name: onSearch
+    desc: "Callback que se ejecuta con la query debounceada"
+  - name: placeholder
+    desc: "Placeholder del input (por defecto 'Search...')"
+  - name: debounceMs
+    desc: "Delay en milisegundos para el debounce (por defecto 300)"
+output: "Componente SearchBar que renderiza input de búsqueda con icono y botón de limpiar"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react", lucide-react, react]
+output: "Componente Select que renderiza dropdown genérico accesible con grupos, separadores y posicionamiento automático"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: props
+    desc: "Configuración: título, secciones con campos (text, number, toggle, select, textarea) y callback onSave"
+output: "Componente ReactElement que renderiza página de configuración con sidebar y secciones navegables"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/dialog", "class-variance-authority", "lucide-react"]
+output: "Componente Sheet que renderiza panel deslizante lateral accesible con animaciones"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente SimpleSelect que renderiza dropdown simplificado con soporte para opciones planas o agrupadas"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente Skeleton que renderiza placeholder de carga con 6 variantes preconfiguradas (text, card, avatar, button, table)"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente Sparkline que renderiza mini gráfico SVG inline con variantes line, area y bar"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react/switch"]
+output: "Componente SwitchToggle que renderiza switch on/off accesible con label opcional"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react", class-variance-authority]
+output: "Componente Tabs que renderiza sistema de navegación por tabs con orientación y variantes configurables"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: []
+output: "Componente Textarea que renderiza input multilinea accesible con auto-resize opcional"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente ThemeProvider que renderiza context de tema con persistencia en localStorage y hook useTheme"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["class-variance-authority", "lucide-react"]
+output: "Componente Toast que renderiza notificación temporal con variantes semánticas, auto-dismiss y hook useToast"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: ["@base-ui/react", react]
+output: "Componente Tooltip que renderiza tooltip accesible con posicionamiento automático y delay configurable"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: options
+    desc: "Configuración: fps (target), draw (callback de renderizado), opcionalmente DPR"
+output: "Hook que retorna canvasRef y renderFpsRef para renderizado animado a N fps"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: opts
+    desc: "Configuración: eventName, onEvent callback, once, enabled para controlar suscripción"
+output: "Hook que retorna lastData, eventCount, emit y funciones para suscribirse a eventos Wails bidireccionales"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: opts
+    desc: "Configuración: mutationFn, invalidateQueries, onMutate para optimistic updates"
+output: "Hook que retorna mutate, mutateAsync, isLoading, error para ejecutar escrituras IPC con cache"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: opts
+    desc: "Configuración: queryKey para cache, queryFn que ejecuta binding Wails, enabled, refetchInterval, staleTime"
+output: "Hook que retorna data, loading, error, refetch, invalidate para queries cacheadas vía IPC"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,10 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+params:
+  - name: opts
+    desc: "Configuración: streamName, startFn/stopFn para control, bufferSize, transform para procesamiento"
+output: "Hook que retorna data (array bufferado), isStreaming, start, stop, clear para streaming Go→TS"
 tested: false
 tests: []
 test_file_path: ""
@@ -14,6 +14,7 @@ returns: []
 returns_optional: false
 error_type: ""
 imports: [react]
+output: "Componente WailsProvider que proporciona context de cache y opciones default para hooks Wails"
 tested: false
 tests: []
 test_file_path: ""