Bridge Mongo

A fully typed mongoose ORM

MongoDBORM
bridge-codes/bridge-mongomongo.bridge.codesbridge-mongo

README


Bridge Mongo


Bridge-mongo is a typed framework built on top of Mongoose, the popular MongoDB object-document mapping (ODM) library. It provides a type-safe approach to querying MongoDB databases that makes it almost impossible to write poorly constructed queries, all while using the same syntax as Mongoose.

Try it live

👉 See more informations on mongo.bridge.codes 👈

Documentation


Full documentation for bridge-mongo can be found here.

Installation


  1. ```bash
  2. # npm
  3. npm install bridge-mongo
  4. # Yarn
  5. yarn add bridge-mongo
  6. # pnpm
  7. pnpm add bridge-mongo
  8. ```

Quickstart


Define your Schemas


Defining your schemas in bridge-mongo is just as easy as it is with Mongoose. You can define your schemas using Mongoose's schema syntax, and then use the createDB function to create your models.

When you use createDB, bridge-mongo will automatically create and register each model with Mongoose using the keys from your schema object as the model names. This means you can define all of your schemas in one place and have them automatically created and registered as models for you.

  1. ```ts twoslash title='index.ts'
  2. import { createDB, Schema, mongoose } from 'bridge-mongo';

  4. // Defining a User Schema
  5. const userSchema = new Schema({
  6.   name: { type: String, required: true },
  7.   email: String,
  8.   age: { type: Number, default: 18 },
  9.   job: { type: String, enum: ['developer', 'designer'] },
  10.   settings: {
  11.     isActive: Boolean,
  12.   },
  13. });

  15. // Defining a Post Schema
  16. const postSchema = new Schema(
  17.   {
  18.     text: { type: String, required: true },
  19.     userId: { type: mongoose.Types.ObjectId, req: true },
  20.     likes: Number,
  21.   },
  22.   { timestamps: true },
  23. );

  25. // The keys correspond to the model Name
  26. const DB = createDB({
  27.   User: userSchema,
  28.   Post: postSchema,
  29. });
  30. ```

Connect to MongoDB


Connecting to your MongoDB database using bridge-mongo is just as easy as it is with Mongoose. In fact, you can import mongoose directly from bridge-mongo and use its connect function to connect to your database.

  1. ```ts twoslash title='index.ts'
  2. import { mongoose } from 'bridge-mongo';

  4. const launch = async () => {
  5.     await mongoose.connect('Your MongoDB URL here');

  7.     console.log('Connected!')
  8. }

  10. launch();
  11. ```


Start enjoying type safety


You can enjoy the benefits of total type safety and guidance through TypeScript. The fully typed query results and error handling provided by bridge-mongo make it easy to write correct, efficient queries with confidence.

Read the documentation to get started or get a look to the examples below.

Some Queries examples:

  1. ```ts
  2. import { isError } from 'bridge-mongo';

  4. async () => {
  5.   const user = await DB.user.create({ name: 'Nab' });

  7.   const post = await DB.post.findOne({ userId: user._id }, {text: 1});

  9.   if (!isError(post)) console.log(post)


  12.   const posts = await DB.post.find({ likes: { $gt: 10 }});

  14.   const res = await DB.user.findByIdAndUpdate(user._id, { name: 'Neo' }, { projection: { name: 1 } })
  15. }
  16. ```

Some Aggregate examples:

  1. ```ts twoslash title='index.ts'
  2. async () => {
  3.   
  4.   // Fetching all users that have created post with their posts
  5.   const blogers = await DB.user
  6.     .aggregate()
  7.     .project({ name: 1 })
  8.     .lookup({ from: 'posts', localField: '_id', foreignField: 'userId' })
  9.     .match({ 'posts.0': { $exists: true } })
  10.     .exec();

  12.   // Fetching all posts from the last 24 hours with their author only if he's >= 21 years old

  14.   const yesterday = new Date(new Date().getTime() - 24 * 60 * 60 * 1000);

  16.   const posts = await DB.post
  17.     .aggregate()
  18.     .project({ text: 1, createdAt: 1, userId: 1 })
  19.     .match({ createdAt: { $gt: yesterday } })
  20.     .lookup({ from: 'users', let: { userId: '$userId' }, as: 'user' }, (user, { userId }) =>
  21.       user
  22.         .match({ $expr: { $eq: ['$_id', userId] }, age: { $gte: 21 } })
  23.         .project({ name: 1 })
  24.         .limit(1),
  25.     )
  26.     .unwind('$user')
  27.     .unset('userId')
  28.     .exec();
  29. }
  30. ```


Bridge-mongo is constantly evolving and adding new features to provide a fully typed, robust, and easy-to-use interface for interacting with MongoDB. While many essential functions are already implemented, there are still many more features that can be added to meet specific use cases. If you are interested in contributing or discussing features that you'd like to see implemented, you can join the Bridge-mongo Discord server and be a part of the community.