@tinya-code/gas-admin-ui 0.2.0-alpha.11 → 0.2.0-alpha.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinya-code/gas-admin-ui",
-  "version": "0.2.0-alpha.11",
+  "version": "0.2.0-alpha.13",
   "description": "Motor de render Angular para admin CRUD: declará ResourceSchema y el motor dibuja vistas, campos y widgets.",
   "repository": {
     "type": "git",

package/types/tinya-code-gas-admin-ui.d.ts

@@ -3307,6 +3307,115 @@ export declare const columnFormatDescriptors: readonly RenderDescriptor[];
  * existe para los 20 campos y los 6 widgets.
  */
 export declare const COLUMN_FORMAT_TYPES: readonly ["text", "badge", "thumbnail", "boolean", "number", "currency", "date"];
+/**
+ * Descripciones centralizadas del catálogo de campos del motor `@tinya-code/gas-admin-ui`.
+ *
+ * Este archivo es el único lugar donde se editan los textos descriptivos de
+ * cada propiedad del schema. Los JSDoc de `schema.model.ts` usan estos mismos
+ * textos para que el editor (VSCode) muestre tooltips al pasar el cursor
+ * sobre una propiedad del schema del consumidor.
+ *
+ * Estructura: clave de propiedad → descripción en español.
+ *
+ * Uso en el consumidor (loyalty-admin, etc.):
+ *   import { schemaDescriptions } from '@tinya-code/gas-admin-ui';
+ *   schemaDescriptions['docLink']; // 'URL de documentación externa para este campo.'
+ *
+ * Nota: este objeto no se renderiza en la UI; solo existe para documentación
+ * y tooltips del editor. Para renderizar tooltips en el formulario usa
+ * `description` en cada campo del schema del consumidor.
+ */
+export declare const schemaDescriptions: {
+  readonly key: "Nombre de la propiedad en el JSON que envía/recibe el back.";
+  readonly label: "Rótulo visible para el usuario en el formulario y la ficha.";
+  readonly help: "Texto corto de ayuda que se muestra debajo del campo.";
+  readonly placeholder: "Texto sugerente que se muestra dentro del input cuando está vacío.";
+  readonly required: "Si es obligatorio. El back también lo valida (R7.4).";
+  readonly default: "Valor por defecto si el registro no trae este campo (ej. `default: \"none\"` en un `select`/`dropdown`).";
+  readonly readonly: "Si el campo es solo lectura (no editable en el formulario).";
+  readonly readonlyOn: "Bloquea el campo solo en creación, solo en edición o siempre.";
+  readonly readonlyWhen: "Condición bajo la cual el campo es solo lectura (expresión sobre otros campos).";
+  readonly visibleWhen: "Condición bajo la cual el campo se muestra u oculta.";
+  readonly hiddenOn: "Oculta el campo en creación, en edición o siempre.";
+  readonly dependsOn: "Selección dependiente (guía §1: país → ciudad). Clave del campo padre del mismo nivel.";
+  readonly validators: "Reglas de validación (mínimo, máximo, patrón, unicidad, etc.).";
+  readonly width: "Ancho en la grilla del formulario (1–12), igual que un widget del dashboard.";
+  readonly section: "Id de la sección/pestaña del layout a la que pertenece (base.md §4).";
+  readonly read: "Código de nivel de acceso requerido para leer el campo.";
+  readonly write: "Código de nivel de acceso requerido para escribir el campo.";
+  readonly description: "Descripción corta de para qué sirve este campo. Se muestra como tooltip al pasar el cursor sobre el rótulo.";
+  readonly docLink: "URL de documentación externa para este campo (se abre al hacer clic en el tooltip).";
+  readonly value: "Valor que se envía al back cuando se elige esta opción.";
+  readonly labelOption: "Texto visible de la opción.";
+  readonly disabled: "Si la opción está deshabilitada (no se puede elegir).";
+  readonly type: "Tipo de campo: `text`, `color`, `number`, `currency`, `boolean`, `select`, `dropdown`, `rich-select`, `multiselect`, `url`, `email`, `phone`, `date`, `time`, `readonly-text`, `slug`, `textarea`, `relation`, `image`, `file`, `group`, `list`, `string-list`, `key-value`.";
+  readonly maxLength: "Longitud máxima de caracteres permitida.";
+  readonly pattern: "Expresión regular que debe cumplir el valor.";
+  readonly rows: "Número de filas visibles del textarea.";
+  readonly minWords: "Cantidad mínima de palabras.";
+  readonly maxWords: "Cantidad máxima de palabras.";
+  readonly tokens: "Marcadores insertables como chips bajo el área (plantillas de mensaje).";
+  readonly from: "Campo del registro del que se autogenera el slug.";
+  readonly lockAfterCreate: "Bloquea el campo una vez creado el registro (por defecto: sí).";
+  readonly min: "Valor mínimo permitido.";
+  readonly max: "Valor máximo permitido.";
+  readonly step: "Incremento entre valores permitidos.";
+  readonly decimals: "Número de decimales mostrados.";
+  readonly currencyFrom: "Campo del registro del que se toma la moneda (ej. `currency`).";
+  readonly trueLabel: "Texto que se muestra cuando el valor es verdadero.";
+  readonly falseLabel: "Texto que se muestra cuando el valor es falso.";
+  readonly source: "De dónde salen las opciones: `{ resource, view?, params?, … }` (F8 · R6.5).";
+  readonly resource: "Recurso declarado (`resource.id`): su listado es el de las opciones.";
+  readonly view: "Vista declarada en `resource.views` (opcional): filtra en el back.";
+  readonly params: "Valores interpolados para la vista (`{campo}` ← contexto).";
+  readonly labelField: "Etiqueta por defecto de las filas (si no, `titleField` del recurso).";
+  readonly valueField: "Valor por defecto de las filas (si no, `keyField` del recurso).";
+  readonly secondaryField: "Segundo dato a mostrar junto a la etiqueta (ej. \"Juan Pérez · DNI 123\").";
+  readonly onlyActive: "Cargar solo registros activos (lo exige además la FK en el back).";
+  readonly accept: "Tipos aceptados (ej. `image/*`, `image/png,image/jpeg` o `pdf,docx`).";
+  readonly maxSizeMB: "Tamaño máximo del archivo en megabytes.";
+  readonly aspectRatio: "Relación de aspecto de la vista previa (ej. `16/9`).";
+  readonly previewSize: "Tamaño de la vista previa.";
+  readonly formatCurrency: "Campo del registro del que se toma la moneda (ej. `currency`).";
+  readonly display: "Presentación del grupo: `card`, `collapsible` o `inline`.";
+  readonly fields: "Campos de cada item (cualquier tipo, incluso `group` o `list`).";
+  readonly minItems: "Cantidad mínima de items.";
+  readonly maxItems: "Cantidad máxima de items.";
+  readonly sortable: "Si se puede reordenar (por defecto: sí).";
+  readonly positionField: "Campo donde se guarda el orden dentro de cada item (`position`).";
+  readonly addLabel: "Etiqueta del botón para agregar un item nuevo.";
+  readonly emptyText: "Texto que se muestra cuando no hay items.";
+  readonly itemDisplay: "Cómo se muestra cada item: `card`, `row` o `accordion`.";
+  readonly itemFields: "Campos de cada item (cualquier tipo, incluso `group` o `list`).";
+  readonly itemTitle: "Campo del item usado como título cuando está colapsado.";
+  readonly primaryFirst: "El primer item tiene significado especial (ej. imagen principal).";
+  readonly itemType: "Tipo permitido de cada item (base.md §9: solo `text`, `url` o `email`).";
+  readonly sort: "Si la lista se ordena alfabéticamente o por posición.";
+  readonly filter: "Si el listado permite filtrado por texto.";
+  readonly search: "Campos buscables en el listado.";
+  readonly filters: "Filtros declarados para el listado.";
+  readonly listColumns: "Columnas que se muestran en el listado.";
+  readonly searchable: "Si el campo es buscable.";
+  readonly filterable: "Si el campo es filtrable.";
+  readonly sortableItems: "Si los items de la lista se pueden reordenar.";
+  readonly groupBy: "Campo por el que agrupar los items.";
+  readonly cardWidth: "Ancho de cada tarjeta de opción en la grilla (1–12). Por defecto `4` (3 tarjetas por fila en escritorio).";
+  readonly cardCols: "Cuántas tarjetas mostrar por fila en el punto de ruptura `lg`. Sobrescribe el cálculo automático basado en `cardWidth`.";
+  readonly hintMetric: "Texto secundario bajo la cifra (estático, va en el schema).";
+  readonly unitChart: "Sufijo de las cifras del eje («unidades», «S/»).";
+  readonly segments: "Segmentos de la barra de distribución porcentual.";
+  readonly actions: "Acciones de navegación por fila.";
+  readonly labelAction: "Etiqueta de la acción.";
+  readonly icon: "Icono de la acción.";
+  readonly navigateTo: "Ruta de destino de la acción.";
+  readonly variant: "Variante visual: `primary`, `secondary` u `outline`.";
+  readonly widgets: "Widgets del panel. Se declara en `ResourceSchema.widgets` — no en `fields`, porque un KPI no es un campo.";
+  readonly mobileWidth: "Ancho en la grilla en mobile (1–12). Por defecto `12` (ancho completo, apilado).";
+  readonly sourceWidget: "De dónde saca sus datos: `DataSource` o `{ kind: \"payload\" }`.";
+  readonly hintWidget: "Texto secundario bajo la cifra (estático, va en el schema).";
+  readonly unitWidget: "Sufijo de las cifras del eje.";
+};
+export type SchemaDescriptionKey = keyof typeof schemaDescriptions;
 export declare const layoutDescriptors: readonly LayoutDescriptor[];
 export declare const viewDescriptors: readonly RenderDescriptor[];
 /**