Descripción general del backend

Descripción general

El backend de Rebase es un servidor Node.js construido sobre Hono que proporciona:

• API REST — Puntos finales CRUD auto-generados para cada colección
• Autenticación — Tokens JWT, Google OAuth, gestión de usuarios/roles
• Almacenamiento — Carga/descarga de archivos con sistema de archivos local o S3
• WebSocket — Sincronización de datos en tiempo real a través de PostgreSQL LISTEN/NOTIFY
• Historial de entidades — Registro de auditoría para cada cambio de datos
• Ramificación de la base de datos — Copias de base de datos instantáneas y aisladas para desarrollo/staging/pruebas
• Tareas Cron — Tareas en segundo plano programadas con panel de monitoreo

Todo se inicializa con una única función:

import { initializeRebaseBackend } from "@rebasepro/server";
import { createPostgresAdapter } from "@rebasepro/server-postgres";
import { env } from "./env";

const instance = await initializeRebaseBackend({
    app,
    server,
    collectionsDir: "./config/collections",
    database: createPostgresAdapter({
            connection: db,
            schema: { tables, enums, relations }
        }),
    auth: {
        jwtSecret: env.JWT_SECRET,
    },
    storage: { type: "local", basePath: "./uploads" },
    history: true,
    enableSwagger: env.NODE_ENV !== "production"
});

Qué se crea

Después de la inicialización, se montan estas rutas:

Path	Propósito
/api/auth/*	Autenticación (registro, inicio de sesión, actualización, Google OAuth)
/api/admin/*	Gestión de usuarios y roles (solo para administradores)
/api/storage/*	Carga, descarga y eliminación de archivos
/api/data/collections	Punto final de metadatos de la colección
/api/data/:slug	Operaciones CRUD por colección (GET, POST, PUT, DELETE)
/api/data/:slug/:id/history	Historial de cambios de la entidad (cuando está habilitado)
/api/data/docs	Especificación OpenAPI (cuando enableSwagger: true)
/api/data/swagger	Swagger UI (modo de desarrollo, cuando enableSwagger: true)
/api/functions/*	Rutas de funciones personalizadas (cuando functionsDir está configurado)
/api/cron/*	Gestión de tareas cron (solo para administradores, cuando cronsDir está configurado)
WebSocket on upgrade	Suscripciones en tiempo real

Referencia de configuración

interface RebaseBackendConfig {
    // HTTP framework
    app: Hono;               // Hono application instance
    server: Server;           // Node.js HTTP server (for WebSocket attachment)
    basePath?: string;        // Route prefix (default: "/api")

    // Collections
    collections?: CollectionConfig[];  // Your collection definitions
    collectionsDir?: string;  // Auto-load collections from a directory

    // Bootstrappers (Databases, Auth, Realtime, etc.)
    bootstrappers: BackendBootstrapper[];

    // Authentication
    auth?: AuthConfig;

    // File storage
    storage?: BackendStorageConfig | Record<string, BackendStorageConfig>;

    // Entity history
    history?: boolean | HistoryConfig;

    // OpenAPI/Swagger
    enableSwagger?: boolean;

    // Custom API endpoints
    functionsDir?: string;    // Auto-load Hono routes from a directory

    // Scheduled tasks
    cronsDir?: string;        // Auto-load cron jobs from a directory

    // Logging
    logging?: { level?: "error" | "warn" | "info" | "debug" };
}

La instancia del backend

initializeRebaseBackend devuelve una RebaseBackendInstance con acceso a servicios internos:

const instance = await initializeRebaseBackend(config);

// Internal service access
instance.driver              // Default data driver
instance.driverRegistry      // All drivers (for multi-database)
instance.realtimeService     // Default realtime service
instance.auth?.userService       // User management
instance.auth?.roleService       // Role management
instance.storageController   // Default storage
instance.storageRegistry     // All storage backends
instance.collectionRegistry  // Collection metadata
instance.history?.historyService // Entity history
instance.cronScheduler       // Cron job scheduler (when cronsDir is set)

Nota: Aunque la instance expone estos servicios internos, el código de la aplicación (como funciones personalizadas y tareas cron) debe usar el singleton global rebase de @rebasepro/server para interactuar con la API del backend.

API REST

La API REST se auto-genera a partir de tus colecciones. Cada colección obtiene estos puntos finales:

Método	Path	Descripción
GET	/api/data/:slug	Listar entidades (con filtro, orden, límite, búsqueda)
GET	/api/data/:slug/:id	Obtener una única entidad
POST	/api/data/:slug	Crear una nueva entidad
PUT	/api/data/:slug/:id	Actualizar una entidad
DELETE	/api/data/:slug/:id	Eliminar una entidad

Parámetros de consulta

Parámetro	Descripción	Ejemplo
filter	Condiciones de filtro codificadas en JSON	?filter={"active":["==",true]}
orderBy	Campo de ordenación	?orderBy=created_at
order	Dirección de ordenación	?order=desc
limit	Tamaño de página	?limit=25
startAfter	Cursor para paginación	?startAfter=encodedCursor
search	Búsqueda de texto completo	?search=laptop

WebSocket

El servidor WebSocket se adjunta al mismo servidor HTTP y proporciona suscripciones en tiempo real:

• Suscribirse a cambios en la colección — recibir notificaciones cuando cualquier entidad en una colección es creada, actualizada o eliminada
• Suscribirse a cambios en la entidad — recibir notificaciones cuando una entidad específica cambia
• Manejo automático de la reconexión en el SDK del cliente

El backend usa internamente PostgreSQL LISTEN/NOTIFY. Para implementaciones multi-instancia, proporciona una connectionString en tu PostgresBootstrapper para habilitar la transmisión entre instancias.

Manejo de errores

El backend incluye un manejador de errores que captura todas las excepciones y devuelve respuestas de error estructuradas:

{
    "error": {
        "message": "Entity not found",
        "code": "not-found",
        "status": 404
    }
}

Si la inicialización falla (por ejemplo, error de conexión a la base de datos), el servidor aún se inicia pero devuelve 503 para todas las solicitudes API, con un mensaje de error descriptivo en los registros.

Próximos pasos

• Autenticación — JWT, Google OAuth, gestión de usuarios
• Almacenamiento — Almacenamiento de archivos local y S3
• Callbacks de entidad — Hooks de ciclo de vida y API context.data
• Historial de entidades — Registro de auditoría
• Funciones personalizadas — Añadir puntos finales de API personalizados
• Tareas Cron — Tareas en segundo plano programadas
• Ramificación de la base de datos — Copias instantáneas de bases de datos para desarrollo/staging

---