SettingField
Un ajuste. Prioridad en la extension: ctx.settings[key] (dominio) > variable legacyEnv (heredada, en ctx.env) > default.
Firma
export interface SettingField {
// 27 miembros: ver la tabla
}Miembros (27)
| Nombre | Tipo | Descripción |
|---|---|---|
| keyobligatorio | string | Nombre del ajuste (camelCase) o, si secret, de la credencial (MAYUSCULAS, igual que ENV_READ). |
| typeobligatorio | 'string' | 'multiline' | 'number' | 'boolean' | 'enum' | 'multienum' | 'list' | 'json' | 'objects' | 'user' | 'users' | 'userMap' | 'secret' | Sin descripción. |
| secretopcional | boolean | true = credencial cifrada del dominio, WRITE-ONLY: tras guardarla jamas se vuelve a leer (la API solo da { set, updatedAt, last4? }); vacio = sin cambio, null = borrar (auditado). |
| writeOnlyopcional | boolean | Sin descripción. |
| revealLast4opcional | boolean | Solo secretos: la API puede devolver los ultimos 4 caracteres (apagado por defecto). |
| valueTypeopcional | 'boolean' | 'string' | 'number' | 'select' | Solo type userMap: tipo del valor por usuario. |
| filteropcional | { minLevel?: number; role?: string; } | Solo type user / users / userMap: acota los usuarios elegibles del dominio. Se guarda el id estable (nunca el correo). |
| labelobligatorio | SettingText | Sin descripción. |
| descriptionopcional | SettingText | Sin descripción. |
| placeholderopcional | string | Sin descripción. |
| defaultopcional | unknown | Sin descripción. |
| requiredopcional | boolean | Sin descripción. |
| groupopcional | string | Sin descripción. |
| optionsopcional | Array<string | SettingOption> | Sin descripción. |
| minopcional | number | Sin descripción. |
| maxopcional | number | Sin descripción. |
| integeropcional | boolean | Sin descripción. |
| maxLengthopcional | number | Sin descripción. |
| maxItemsopcional | number | Sin descripción. |
| itemMaxLengthopcional | number | Sin descripción. |
| patternopcional | string | Sin descripción. |
| formatopcional | 'email' | 'url' | 'domain' | 'regex' | Sin descripción. |
| itemFieldsopcional | SettingField[] | Solo type objects: sub-campos de cada elemento (un sub-campo secret es un secreto POR ELEMENTO, write-only; el handler lo recibe solo dentro del sandbox, en el propio elemento). Cada elemento tiene un id estable. |
| templatesopcional | Array<{ id: string; label: SettingText; description?: SettingText; value: Record<string, unknown>; }> | Solo type objects: elementos sugeridos que el admin anade con un clic. |
| legacyEnvopcional | string | Variable de entorno heredada que respalda el ajuste (solo respaldo; el panel avisa de que migre). |
| visibleWhenopcional | { key: string; in: string[]; } | Sin descripción. |
| envImportopcional | boolean | false = sin boton "Importar desde el entorno". |
Usado en / Referenciado por
Referencia a
Fuente: bloomx-extensions/_shared/sdk/manifest.d.ts:337 · manifest.d.ts