README

Mongo Query Resolver

MongoQueryResolver is an open-source library which makes querying and formating MongoDB databases easy. It runs on top of mongodb find function and can

Include related models. (BelongsTo | HasOne | HasMany | HasAndBelongsToMany | ReferencesMany)
Do nested queries with infinite recursion
Formating

Dependencies

[Lodash] - A modern JavaScript utility library.
[MongoDB] - A general purpose, document-based, distributed database.

Installation

MongoQueryResolver requires Node.js v10+ to run.

$ npm i mongoqueryresolver -s

Usage

Let's assume we have few collections:

Author: { firstName, lastName, _id, age, phone,  email }
Book: { title, description, _id, rating, storeId,  publishedDate }
AuthorBook: { authorId, bookId, _id }
Store: { name, adrress, _id, zipcode, }
Tag: { name, authorIds, _id }

Basic Example

const MQR = require('mongoqueryresolver');

(async function () {
    const db = await MQR.init("mongodb://localhost:27017/testdb");
    const authors = await MQR.filter({
        collection: "Author",
        limit: 3,
        where: {
            age: { $gt: 18 }
        },
        fields: [
            "firstName",
            {
                field: "Age",
                value: "age"
            }
        ]
    });
    console.log(authors);
})();

Output

[
  {
    "firstName": "Sylvester",
    "Age": 82
  },
  {
    "firstName": "Kenny",
    "Age": 72
  },
  {
    "firstName": "Emerson",
    "Age": 20
  }
]

More realistic Example

const MQR = require('mongoqueryresolver');

(async function(){
    const db = await MQR.init("mongodb://localhost:27017/testdb");
    let authors = await MQR.filter({
        collection: "Author",
        limit: 2,
        skip:20,
        sort:{
            firstName:1
        }
        fields: [
            "_id",
            "firstName",
            "lastName",
            "age",
            "phone",
            "email",
            {
                field: "type",
                value: "Author",
                resolve: false
            },
            {
                field: "stores",
                value: "books.$.store",
                makeUnique: true,
                uniqBy: "name"
            },
            {
                field: "books",
                value: "books.$.title"
            }
        ],
        include: {
            books: {
                relation: "hasAndBelongsToMany",
                collection: "Book",
                foreignKey: "authorId",
                relationKey: "bookId",
                through: "AuthorBook",
                scope: {
                    include: {
                        store: {
                            relation: "belongsTo",
                            collection: "Store",
                            foreignKey: "storeId",
                            scope: {
                                fields: [
                                    "name",
                                    {
                                        field: "Street Address",
                                        value: "address"
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    });
    console.log(authors);
})();