npm.io
0.6.1 • Published 5d ago

@rebasepro/server-mongodb

Licence
MIT
Version
0.6.1
Deps
5
Size
737 kB
Vulns
0
Weekly
320
SummaryDependencyVersions

@rebasepro/server-mongodb

MongoDB database driver for Rebase.

Installation

pnpm add @rebasepro/server-mongodb

What This Package Does

Implements the Rebase BackendBootstrapper and backend interfaces for MongoDB. Provides a complete data driver, change-stream-based realtime, entity history, auth repositories, and WebSocket support. Plug it into @rebasepro/server-core via createMongoBootstrapper(), or use the standalone createMongoBackend() factory for direct access.

Key Exports

Export Description
createMongoBootstrapper(config) Creates a BackendBootstrapper for use with initializeRebaseBackend({ bootstrappers: [...] }).
createMongoBackend(config) Standalone factory — returns a MongoBackendInstance with driver, entity service, realtime, admin, and lifecycle methods.
createMongoDelegate(db) Convenience factory for just the MongoDriver (DataDriver).
createMongoRealtimeService(db) Creates a MongoDB change-stream-based realtime provider.
createMongoEntityRepository(db) Creates an EntityRepository for direct CRUD.
createMongoDBConnection(url, dbName) Connects to MongoDB and returns a MongoDBConnection wrapper.
MongoDBConnection DatabaseConnection implementation wrapping MongoClient + Db.
MongoDriver The DataDriver implementation for MongoDB.
MongoEntityService Low-level entity CRUD service.
MongoRealtimeService Change-stream-based RealtimeProvider.
MongoCollectionRegistry In-memory collection registry.
isMongoBackendConfig(config) Type guard for MongoBackendConfig.

Quick Start

With server-core (recommended)
import { MongoClient } from "mongodb";
import { createMongoBootstrapper } from "@rebasepro/server-mongodb";
import { initializeRebaseBackend } from "@rebasepro/server-core";

const client = new MongoClient("mongodb://localhost:27017");
await client.connect();
const db = client.db("my_database");

const backend = await initializeRebaseBackend({
  app,
  server,
  bootstrappers: [
    createMongoBootstrapper({ connection: db, client }),
  ],
  collections,
  auth: { /* ... */ },
});
Standalone (without server-core)
import { MongoClient } from "mongodb";
import { createMongoBackend } from "@rebasepro/server-mongodb";

const client = new MongoClient("mongodb://localhost:27017");
await client.connect();

const backend = createMongoBackend({
  type: "mongodb",
  connection: client.db("my_database"),
  client,
  collections: myCollections,
});

// Use directly
const health = await backend.healthCheck();
const entities = await backend.entityService.fetchCollection("users", {});

// Cleanup
await backend.destroy();

Related Packages

Package Role
@rebasepro/server-core Backend orchestrator (peer dependency, optional)
@rebasepro/types Shared interfaces (BackendBootstrapper, DataDriver, RealtimeProvider)
@rebasepro/common Default collections and shared utilities

Keywords

rebasecmsadminadmin panelmongodbbackenddatabase