Apps
Una app pone una herramienta tuya dentro de la consola, junto al contenido sobre el que trabaja. Su interfaz es una página web que alojas tú, y lee y escribe a través de la misma API de GraphQL que usa tu aplicación.
Cuatro ubicaciones
La página de una app se incrusta en la consola como un iframe, en uno de cuatro lugares: una página completa en la navegación, una pestaña en el editor de registros, un panel lateral en el editor de registros, o un editor de campo que sustituye la entrada predeterminada de un campo. Una pestaña o un panel lateral está vinculado a modelos y aparece cuando hay abierto un registro de un modelo coincidente.
Trabajar con el registro
Las ubicaciones del editor hablan con la consola mediante el Editor SDK de @foir/sdk, que requiere React 18 o posterior. La consola envía los valores, el esquema y el tema del registro cuando se carga la página, y sigue al mando del guardado, la publicación y el versionado. Una página completa actúa como el miembro del equipo que la está viendo, solo con los alcances que declara su ubicación y que esa persona también tiene. Su token dura cinco minutos cada vez y termina cuando cierra sesión.
Un manifiesto
Una app se describe con un manifiesto JSON en una URL https que tú eliges, con name y version como únicos campos obligatorios. Además de una página, una app puede aportar credenciales, operaciones, hooks de ciclo de vida y formas de datos mapeadas a tus modelos al instalarla. Nunca es propietaria de modelos.
Instalar, y el marketplace
Instala una app desde el marketplace o pegando la URL de su manifiesto. El marketplace está curado, y una app que no figura en él se instala desde su URL. En ambos casos, la vista previa de instalación muestra exactamente qué puede leer o escribir cada operación de la app.
Herramientas para un solo proyecto
Una pestaña o un panel lateral para un solo proyecto se puede declarar directamente en foir.config.ts y subirse con push. Crea una app cuando la herramienta se vaya a reutilizar entre proyectos. La página que sirves tiene que permitir a la consola como ancestro de frame, o el navegador la muestra en blanco, y el SDK ofrece placementFrameAncestors para eso.
Lee el detalle
La guía de apps cubre el manifiesto, cada ubicación, lo que puede aportar una app y cómo funcionan las instalaciones y las actualizaciones.