feat: add configurable collection name via adapterOptions

Author: hsluoyz

README.md

@@ -56,6 +56,23 @@ const adapter = await MongooseAdapter.newAdapter('mongodb://your_mongodb_uri:270
 
 Additional information regard to options you can pass in you can find in [mongoose documentation](https://mongoosejs.com/docs/connections.html#options)
 
+### Custom Collection Name
+
+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.

src/adapter.ts

@@ -30,6 +30,7 @@ export interface MongooseAdapterOptions {
   autoAbort?: boolean;
   autoCommit?: boolean;
   timestamps?: boolean;
+  collectionName?: string;
 }
 
 export interface policyLine {
@@ -88,10 +89,11 @@ export class MongooseAdapter implements BatchAdapter, FilteredAdapter, Updatable
     this.uri = uri;
     this.options = options;
     this.connection = createConnection(this.uri, this.options);
+    const customCollectionName = adapterOptions?.collectionName || collectionName;
     this.casbinRule = this.connection.model<IModel>(
       modelName,
-      schema(adapterOptions?.timestamps),
-      collectionName
+      schema(adapterOptions?.timestamps, customCollectionName),
+      customCollectionName
     );
   }
 

src/model.ts

@@ -27,7 +27,7 @@ export interface IModel extends Document {
 export const collectionName = 'casbin_rule';
 export const modelName = 'CasbinRule';
 
-export const schema = (timestamps = false) => {
+export const schema = (timestamps = false, customCollectionName?: string) => {
   return new Schema({
     ptype: {
       type: Schema.Types.String,
@@ -59,7 +59,7 @@ export const schema = (timestamps = false) => {
       index: true
     }
   }, {
-    collection: collectionName,
+    collection: customCollectionName || collectionName,
     minimize: false,
     timestamps: timestamps
   });

test/unit/adapter.test.js

@@ -74,4 +74,31 @@ describe('MongooseAdapter', () => {
     assert.isFunction(adapter.removeFilteredPolicy);
     assert.isFunction(adapter.getCasbinRule);
   });
+
+  it('Should use default collection name when not provided', async () => {
+    const adapter = new MongooseAdapter('mongodb://localhost:27001/casbin');
+    const casbinRule = adapter.getCasbinRule();
+
+    assert.equal(casbinRule.schema.options.collection, 'casbin_rule');
+
+    await adapter.close();
+  });
+
+  it('Should use custom collection name when provided', async () => {
+    const adapter = new MongooseAdapter('mongodb://localhost:27001/casbin', {}, { collectionName: 'casbinRule' });
+    const casbinRule = adapter.getCasbinRule();
+
+    assert.equal(casbinRule.schema.options.collection, 'casbinRule');
+
+    await adapter.close();
+  });
+
+  it('Should use custom collection name via newAdapter', async () => {
+    const adapter = await MongooseAdapter.newAdapter('mongodb://localhost:27001/casbin', {}, { collectionName: 'customCasbinRules' });
+    const casbinRule = adapter.getCasbinRule();
+
+    assert.equal(casbinRule.schema.options.collection, 'customCasbinRules');
+
+    await adapter.close();
+  });
 });