a2ui-project / a2ui-project/a2ui
refactor(web_core): extract shared Zod schema introspection and metadata utilities
- Lenguaje dominante
- TypeScript
- Estrellas
- 16.4k
- Forks
- 1.3k
- Merge medio
- 3 d 15 h
- PR fusionados (30 d)
- 134
Descripción
## Overview
`GenericBinder` (`renderers/web_core/src/v0_9/rendering/generic-binder.ts`) and `NodeResolver` (`renderers/web_core/src/v0_9/nodes/ref-fields.ts`) both independently inspect Zod schemas:
1. Accessing private `_def` internals (`typeName`, `innerType`, `description`, `options`, `shape()`).
2. Duplicating unwrapping loops for `ZodOptional`, `ZodNullable`, `ZodDefault`, and `ZodEffects`.
3. Defining duplicate schema reference strings (`REF:common_types.json#/$defs/...`).
## Goals
- **Centralize Schema Constants**: Export canonical reference constants (`CHILD_LIST_REF`, `COMPONENT_ID_REF`, `ACTION_REF`, `DATA_BINDING_REF`) from a central location (`renderers/web_core/src/v0_9/schema/constants.ts` or `common-types.ts`).
- **Shared Schema Introspection Utility**: Consolidate unwrapping logic into a dedicated helper module (`renderers/web_core/src/v0_9/schema/schema-reflection.ts`) so callers avoid accessing `_def` directly.
- **Extend Schema Metadata**: Broaden the `a2uiChildRef` metadata pattern introduced in PR #2393 (`markChildRef` / `childRefKindOf`) to `Action` and `Dynamic*` schemas (`a2uiKind: 'action' | 'dynamic' | 'child-list' | 'component-id'`).
## References
- PR #2359: https://github.com/a2ui-project/a2ui/pull/2359
- PR #2393: Node layer schema metadata implementation (commit `3a2f5f24`)
Guía de contribución
Línea de trabajo
Empieza leyendo los dos archivos mencionados: `renderers/web_core/src/v0_9/rendering/generic-binder.ts` y `renderers/web_core/src/v0_9/nodes/ref-fields.ts`. Examina cómo inspeccionan los esquemas de Zod mediante `_def`. Consulta el PR #2393 para entender el patrón de metadatos existente de `a2uiChildRef`. El objetivo es extraer la lógica compartida a nuevos módulos de utilidades, probablemente en `renderers/web_core/src/v0_9/schema/`. El trabajo estará terminado cuando se elimine el código de introspección duplicado de los archivos originales y se sustituya por llamadas a las nuevas utilidades compartidas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- backend-api-design, tooling
- Tipo de issue
- Refactorización
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Activo
- Claridad
- Bien especificado
- Aptitud para principiantes
- 55/100