Sequelize Adapter

[![NPM version][npm-image]][npm-url]
[![NPM download][download-image]][download-url]

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

Sequelize Adapter is the Sequelize adapter for Node-Casbin. With this library, Node-Casbin can load policy from Sequelize supported database or save policy to it.

Based on Officially Supported Databases, the current supported databases are:

- PostgreSQL
- MySQL
- SQLite
- MSSQL

You may find other 3rd-party supported DBs in Sequelize website or other places.

Installation

NPM Install

``bash
npm install casbin-sequelize-adapter --save
`

Yarn Install

`bash
yarn add casbin-sequelize-adapter
`

Testing Locally

Start mysql for tests:

`bash
docker compose up -d
`

`bash
yarn test
`

Simple Example

`typescript
import casbin from 'casbin';
import { SequelizeAdapter } from 'casbin-sequelize-adapter';

async function myFunction() {
// Initialize a Sequelize adapter and use it in a Node-Casbin enforcer:
// The adapter can not automatically create database.
// But the adapter will automatically and use the table named "casbin_rule".
// The second boolean argument: autoCreateTable determines whether the adapter will automatically create the "casbin_rule" table.
// ORM should not create databases automatically.
const a = await SequelizeAdapter.newAdapter(
{
username: 'root',
password: '',
database: 'casbin',
dialect: 'mysql',
},
true,
);

const e = await casbin.newEnforcer('examples/rbac_model.conf', a);

// Check the permission.
e.enforce('alice', 'data1', 'read');

// Modify the policy.
// await e.addPolicy(...);
// await e.removePolicy(...);

// Save the policy back to DB.
await e.savePolicy();
}
``

Getting Help

- Node-Casbin

License

This project is under Apache 2.0 License. See the LICENSE file for the full license text.