casbin-mongoose-adapter

Mongoose Adapter
====
[![NPM version][npm-image]][npm-url]
[![NPM download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/casbin-mongoose-adapter.svg?style=flat-square
[npm-url]: https://npmjs.org/package/casbin-mongoose-adapter
[download-image]: https://img.shields.io/npm/dm/casbin-mongoose-adapter.svg?style=flat-square
[download-url]: https://npmjs.org/package/casbin-mongoose-adapter

Mongoose Adapter is the Mongoose adapter for Node-Casbin. With this library, Node-Casbin can load policy from Mongoose supported database or save policy to it. It is originally developed by @ghaiklor from @elasticio.

Based on Officially Supported Databases, The current supported database is MongoDB.

Mongoose Adapter has been rewritten to TypeScript since v3.x.

Getting Started

Install the package as dependency in your project:

``bash
npm install --save casbin-mongoose-adapter casbin
`
Note: casbin as peerDependencies!

Require it in a place, where you are instantiating an enforcer (read more about enforcer here):

`javascript
const path = require('path');
const { newEnforcer } = require('casbin');
const { MongooseAdapter } = require('casbin-mongoose-adapter');

// const MongooseAdapter = require('casbin-mongoose-adapter');
// You should use this in v2.x

const model = path.resolve(__dirname, './your_model.conf');
const adapter = await MongooseAdapter.newAdapter('mongodb://your_mongodb_uri:27017');
const enforcer = await newEnforcer(model, adapter);
`

That is all what required for integrating the adapter into casbin.
Casbin itself calls adapter methods to persist updates you made through it.

Configuration

You can pass mongooose-specific options when instantiating the adapter:

`javascript
const { MongooseAdapter } = require('casbin-mongoose-adapter');
const adapter = await MongooseAdapter.newAdapter('mongodb://your_mongodb_uri:27017', { mongoose_options: 'here' });
`

Additional information regard to options you can pass in you can find in mongoose documentation

$3

By default, the adapter uses casbin_rule as the collection name. You can customize this by passing a collectionName option in adapterOptions:

`javascript
const { MongooseAdapter } = require('casbin-mongoose-adapter');

// Use custom collection name
const adapter = await MongooseAdapter.newAdapter(
'mongodb://your_mongodb_uri:27017',
{},
{ collectionName: 'casbinRule' }
);
`

This allows you to follow your own database naming conventions (e.g., camelCase).

Filtered Adapter

You can create an adapter instance that will load only those rules you need to.

A simple case for it is when you have separate policy rules for separate domains (tenants).
You do not need to load all the rules for all domains to make an authorization in specific domain.

For such cases, filtered adapter exists in casbin.

`javascript
const { MongooseAdapter } = require('casbin-mongoose-adapter');
const adapter = await MongooseAdapter.newFilteredAdapter('mongodb://your_mongodb_uri:27017');
``

License

Apache-2.0