casbin 5.14.0-beta.1 → 5.14.0

package/CHANGELOG.md

@@ -1,21 +1,16 @@
-# [5.14.0-beta.1](https://github.com/casbin/node-casbin/compare/v5.13.1...v5.14.0-beta.1) (2022-02-27)
+# [5.14.0](https://github.com/casbin/node-casbin/compare/v5.13.2...v5.14.0) (2022-03-18)
 
 
-### Bug Fixes
+### Features
 
-* fix logic error and add unittests ([e36cc23](https://github.com/casbin/node-casbin/commit/e36cc239b1588e884453e5441eda184350fdae39))
-* rename StringAdapter to MemoryAdapter ([0b1019a](https://github.com/casbin/node-casbin/commit/0b1019aa2324ea4ea4c37119728dadac1bcf1fc3))
-* use csv-like format ([3b54c93](https://github.com/casbin/node-casbin/commit/3b54c934d0d9d08a4af18799c1292f9dc728e6a4))
+* **rbac:** add `getUsersForRoleInDomain` & `getRolesForUserInDomain` ([#351](https://github.com/casbin/node-casbin/issues/351)) ([4896ca2](https://github.com/casbin/node-casbin/commit/4896ca260c2f35672b9b520969898155ec616f0b)), closes [#304](https://github.com/casbin/node-casbin/issues/304)
 
+## [5.13.2](https://github.com/casbin/node-casbin/compare/v5.13.1...v5.13.2) (2022-03-02)
 
-### Features
 
-* add policyArrayToString and policyStringToArray to util ([0f66bc1](https://github.com/casbin/node-casbin/commit/0f66bc1b2fcddfd9c6e847dd06fd4a5f53c55fa9))
-* Extend multiple sections type of escapeAssertion ([#180](https://github.com/casbin/node-casbin/issues/180)) ([33c784c](https://github.com/casbin/node-casbin/commit/33c784cbdc0d650ba75b8177b69f41dc0ca11fae))
-* implement csv parser ([968a232](https://github.com/casbin/node-casbin/commit/968a23237b3193e594910f5f798bf349d6bff04c))
-* implement string adapater ([0c59cae](https://github.com/casbin/node-casbin/commit/0c59cae0eba851509ff754b6f523a4feafc11f80))
-* Multiple sections type ([cc58c57](https://github.com/casbin/node-casbin/commit/cc58c57ae4a7c3202c7217497bef8016df93fe26))
-* RBAC with Domains API ([3e38bb5](https://github.com/casbin/node-casbin/commit/3e38bb5a7223657fae21896ba2e0b9b39e099481))
+### Bug Fixes
+
+* *matcher result should be boolean or number* for KeyGet2 ([#347](https://github.com/casbin/node-casbin/issues/347)) ([0257078](https://github.com/casbin/node-casbin/commit/0257078e1302f5ef081ec143afe5c470f4f862e9))
 
 ## [5.13.1](https://github.com/casbin/node-casbin/compare/v5.13.0...v5.13.1) (2022-02-22)
 

package/README.md

@@ -40,58 +40,34 @@
 
 https://casbin.org/docs/en/overview
 
-## Feature
-
-- 😎 Written in TypeScript to provide the type definitions
-- 🎯 Support multiple access model such as ACL, RBAC, ABAC
-- 🎮 Run everywhere on JavaScript platforms such as WEB, Node.js, React-Native, Electron, etc.
-
 ## Installation
 
 ```shell script
 # NPM
-npm install casbin@beta --save
+npm install casbin --save
 
 # Yarn
-yarn add casbin@beta
+yarn add casbin
 ```
 
 ## Get started
 
-New an enforcer with a model string and a memory policy, see [Model](#official-model) section for details:
-
-```typescript
-import { newEnforcer, newModel, MemoryAdapter } from 'casbin';
-
-const model = newModel(`
-[request_definition]
-r = sub, obj, act
-[policy_definition]
-p = sub, obj, act
-[role_definition]
-g = _, _
-[policy_effect]
-e = some(where (p.eft == allow))
-[matchers]
-m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act
-`);
-
-const adapter = new MemoryAdapter(`
-p, alice, data1, read
-p, bob, data2, write
-p, data2_admin, data2, read
-p, data2_admin, data2, write
-g, alice, data2_admin
-`);
-
-const enforcer = await newEnforcer(model, adapter);
+New a `node-casbin` enforcer with a model file and a policy file, see [Model](#official-model) section for details:
+
+```node.js
+// For Node.js:
+const { newEnforcer } = require('casbin');
+// For browser:
+// import { newEnforcer } from 'casbin';
+
+const enforcer = await newEnforcer('basic_model.conf', 'basic_policy.csv');
 ```
 
 > **Note**: you can also initialize an enforcer with policy in DB instead of file, see [Persistence](#policy-persistence) section for details.
 
 Add an enforcement hook into your code right before the access happens:
 
-```typescript
+```node.js
 const sub = 'alice'; // the user that wants to access a resource.
 const obj = 'data1'; // the resource that is going to be accessed.
 const act = 'read'; // the operation that the user performs on the resource.
@@ -111,7 +87,7 @@ if (res) {
 Besides the static policy file, `node-casbin` also provides API for permission management at run-time.
 For example, You can get all the roles assigned to a user as below:
 
-```typescript
+```node.js
 const roles = await enforcer.getRolesForUser('alice');
 ```
 

package/examples/basic_keyget2_model.conf

@@ -0,0 +1,11 @@
+[request_definition]
+r = sub, obj
+
+[policy_definition]
+p = sub, obj
+
+[policy_effect]
+e = some(where (p.eft == allow))
+
+[matchers]
+m = keyGet2(r.obj, p.obj, 'id')

package/examples/basic_keyget2_policy.csv

@@ -0,0 +1 @@
+p, alice, /data/:id

package/lib/{cachedEnforcer.js → cjs/cachedEnforcer.js}

@@ -65,7 +65,7 @@ class CachedEnforcer extends enforcer_1.Enforcer {
     }
 }
 exports.CachedEnforcer = CachedEnforcer;
-// newCachedEnforcer creates a cached enforcer via string or DB.
+// newCachedEnforcer creates a cached enforcer via file or DB.
 async function newCachedEnforcer(...params) {
     return enforcer_1.newEnforcerWithClass(CachedEnforcer, ...params);
 }

package/{es → lib/cjs}/config.d.ts

@@ -16,10 +16,10 @@ export declare class Config implements ConfigInterface {
     /**
      * newConfig create an empty configuration representation from file.
      *
-     * @param text the content of the model file.
+     * @param confName the path of the model file.
      * @return the constructor of Config.
      */
-    static newConfig(text: string): Config;
+    static newConfig(confName: string): Config;
     /**
      * newConfigFromText create an empty configuration representation from text.
      *
@@ -31,7 +31,8 @@ export declare class Config implements ConfigInterface {
      * addConfig adds a new section->key:value to the configuration.
      */
     private addConfig;
-    private parseText;
+    private parse;
+    private parseBuffer;
     private write;
     getBool(key: string): boolean;
     getInt(key: string): number;

package/lib/{config.js → cjs/config.js}

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
 // Copyright 2018 The Casbin Authors. All Rights Reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,8 +14,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = void 0;
+const fs_1 = require("fs");
 class Config {
     constructor() {
         this.data = new Map();
@@ -21,12 +22,12 @@ class Config {
     /**
      * newConfig create an empty configuration representation from file.
      *
-     * @param text the content of the model file.
+     * @param confName the path of the model file.
      * @return the constructor of Config.
      */
-    static newConfig(text) {
+    static newConfig(confName) {
         const config = new Config();
-        config.parseText(text);
+        config.parse(confName);
         return config;
     }
     /**
@@ -37,7 +38,7 @@ class Config {
      */
     static newConfigFromText(text) {
         const config = new Config();
-        config.parseText(text);
+        config.parseBuffer(Buffer.from(text));
         return config;
     }
     /**
@@ -60,8 +61,15 @@ class Config {
             return false;
         }
     }
-    parseText(text) {
-        const lines = text.split('\n').filter((v) => v);
+    parse(path) {
+        const buf = fs_1.readFileSync(path);
+        this.parseBuffer(buf);
+    }
+    parseBuffer(buf) {
+        const lines = buf
+            .toString()
+            .split('\n')
+            .filter((v) => v);
         const linesCount = lines.length;
         let section = '';
         let currentLine = '';

package/{es → lib/cjs}/coreEnforcer.d.ts

@@ -1,6 +1,6 @@
 import { Effector } from './effect';
 import { FunctionMap, Model, PolicyOp } from './model';
-import { Adapter, Watcher } from './persist';
+import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter } from './persist';
 import { RoleManager } from './rbac';
 import { MatchingFunc } from './rbac';
 /**
@@ -12,8 +12,7 @@ export declare class CoreEnforcer {
     protected fm: FunctionMap;
     protected eft: Effector;
     private matcherMap;
-    private defaultEnforceContext;
-    protected adapter: Adapter;
+    protected adapter: UpdatableAdapter | FilteredAdapter | Adapter | BatchAdapter;
     protected watcher: Watcher | null;
     protected rmMap: Map<string, RoleManager>;
     protected enabled: boolean;
@@ -22,7 +21,7 @@ export declare class CoreEnforcer {
     protected autoNotifyWatcher: boolean;
     private getExpression;
     /**
-     * loadModel reloads the model from the model CONF string.
+     * loadModel reloads the model from the model CONF file.
      * Because the policy is attached to a model,
      * so the policy is invalidated and needs to be reloaded by calling LoadPolicy().
      */
@@ -84,17 +83,17 @@ export declare class CoreEnforcer {
     initRmMap(): void;
     sortPolicies(): void;
     /**
-     * loadPolicy reloads the policy from adapter.
+     * loadPolicy reloads the policy from file/database.
      */
     loadPolicy(): Promise<void>;
     /**
-     * loadFilteredPolicy reloads a filtered policy from adapter.
+     * loadFilteredPolicy reloads a filtered policy from file/database.
      *
      * @param filter the filter used to specify which type of policy should be loaded.
      */
     loadFilteredPolicy(filter: any): Promise<boolean>;
     /**
-     * LoadIncrementalFilteredPolicy append a filtered policy from adapter.
+     * LoadIncrementalFilteredPolicy append a filtered policy from file/database.
      *
      * @param filter the filter used to specify which type of policy should be appended.
      */
@@ -107,7 +106,7 @@ export declare class CoreEnforcer {
     isFiltered(): boolean;
     /**
      * savePolicy saves the current policy (usually after changed with
-     * Casbin API) back to adapter.
+     * Casbin API) back to file/database.
      */
     savePolicy(): Promise<boolean>;
     /**

package/lib/{coreEnforcer.js → cjs/coreEnforcer.js}

@@ -18,7 +18,6 @@ const expression_eval_1 = require("expression-eval");
 const effect_1 = require("./effect");
 const model_1 = require("./model");
 const rbac_1 = require("./rbac");
-const enforceContext_1 = require("./enforceContext");
 const util_1 = require("./util");
 const log_1 = require("./log");
 /**
@@ -29,7 +28,6 @@ class CoreEnforcer {
         this.fm = model_1.FunctionMap.loadFunctionMap();
         this.eft = new effect_1.DefaultEffector();
         this.matcherMap = new Map();
-        this.defaultEnforceContext = new enforceContext_1.EnforceContext('r', 'p', 'e', 'm');
         this.watcher = null;
         this.enabled = true;
         this.autoSave = true;
@@ -48,7 +46,7 @@ class CoreEnforcer {
         return expression;
     }
     /**
-     * loadModel reloads the model from the model CONF string.
+     * loadModel reloads the model from the model CONF file.
      * Because the policy is attached to a model,
      * so the policy is invalidated and needs to be reloaded by calling LoadPolicy().
      */
@@ -155,7 +153,7 @@ class CoreEnforcer {
         }
     }
     /**
-     * loadPolicy reloads the policy from adapter.
+     * loadPolicy reloads the policy from file/database.
      */
     async loadPolicy() {
         this.model.clearPolicy();
@@ -166,7 +164,7 @@ class CoreEnforcer {
         }
     }
     /**
-     * loadFilteredPolicy reloads a filtered policy from adapter.
+     * loadFilteredPolicy reloads a filtered policy from file/database.
      *
      * @param filter the filter used to specify which type of policy should be loaded.
      */
@@ -176,7 +174,7 @@ class CoreEnforcer {
         return this.loadIncrementalFilteredPolicy(filter);
     }
     /**
-     * LoadIncrementalFilteredPolicy append a filtered policy from adapter.
+     * LoadIncrementalFilteredPolicy append a filtered policy from file/database.
      *
      * @param filter the filter used to specify which type of policy should be appended.
      */
@@ -207,7 +205,7 @@ class CoreEnforcer {
     }
     /**
      * savePolicy saves the current policy (usually after changed with
-     * Casbin API) back to adapter.
+     * Casbin API) back to file/database.
      */
     async savePolicy() {
         if (this.isFiltered()) {
@@ -313,7 +311,7 @@ class CoreEnforcer {
             await this.model.buildRoleLinks(this.rmMap);
         }
     }
-    *privateEnforce(asyncCompile = true, explain = false, enforceContext = new enforceContext_1.EnforceContext('r', 'p', 'e', 'm'), ...rvals) {
+    *privateEnforce(asyncCompile = true, explain = false, ...rvals) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         if (!this.enabled) {
             return true;
@@ -328,19 +326,19 @@ class CoreEnforcer {
             const rm = value.rm;
             functions[key] = util_1.generateGFunction(rm);
         });
-        const expString = (_b = (_a = this.model.model.get('m')) === null || _a === void 0 ? void 0 : _a.get(enforceContext.mType)) === null || _b === void 0 ? void 0 : _b.value;
+        const expString = (_b = (_a = this.model.model.get('m')) === null || _a === void 0 ? void 0 : _a.get('m')) === null || _b === void 0 ? void 0 : _b.value;
         if (!expString) {
             throw new Error('Unable to find matchers in model');
         }
-        const effectExpr = (_d = (_c = this.model.model.get('e')) === null || _c === void 0 ? void 0 : _c.get(enforceContext.eType)) === null || _d === void 0 ? void 0 : _d.value;
+        const effectExpr = (_d = (_c = this.model.model.get('e')) === null || _c === void 0 ? void 0 : _c.get('e')) === null || _d === void 0 ? void 0 : _d.value;
         if (!effectExpr) {
             throw new Error('Unable to find policy_effect in model');
         }
         const HasEval = util_1.hasEval(expString);
         let expression = undefined;
-        const p = (_e = this.model.model.get('p')) === null || _e === void 0 ? void 0 : _e.get(enforceContext.pType);
+        const p = (_e = this.model.model.get('p')) === null || _e === void 0 ? void 0 : _e.get('p');
         const policyLen = (_f = p === null || p === void 0 ? void 0 : p.policy) === null || _f === void 0 ? void 0 : _f.length;
-        const rTokens = (_h = (_g = this.model.model.get('r')) === null || _g === void 0 ? void 0 : _g.get(enforceContext.rType)) === null || _h === void 0 ? void 0 : _h.tokens;
+        const rTokens = (_h = (_g = this.model.model.get('r')) === null || _g === void 0 ? void 0 : _g.get('r')) === null || _h === void 0 ? void 0 : _h.tokens;
         const rTokensLen = rTokens === null || rTokens === void 0 ? void 0 : rTokens.length;
         const effectStream = this.eft.newStream(effectExpr);
         if (policyLen && policyLen !== 0) {
@@ -389,8 +387,16 @@ class CoreEnforcer {
                             eftRes = result;
                         }
                         break;
+                    case 'string':
+                        if (result === '') {
+                            eftRes = effect_1.Effect.Indeterminate;
+                        }
+                        else {
+                            eftRes = effect_1.Effect.Allow;
+                        }
+                        break;
                     default:
-                        throw new Error('matcher result should be boolean or number');
+                        throw new Error('matcher result should only be of type boolean, number, or string');
                 }
                 const eft = parameters['p_eft'];
                 if (eft && eftRes === effect_1.Effect.Allow) {
@@ -465,11 +471,7 @@ class CoreEnforcer {
      * @return whether to allow the request.
      */
     enforceSync(...rvals) {
-        if (rvals[0] instanceof enforceContext_1.EnforceContext) {
-            const enforceContext = rvals.shift();
-            return util_1.generatorRunSync(this.privateEnforce(false, false, enforceContext, ...rvals));
-        }
-        return util_1.generatorRunSync(this.privateEnforce(false, false, this.defaultEnforceContext, ...rvals));
+        return util_1.generatorRunSync(this.privateEnforce(false, false, ...rvals));
     }
     /**
      * If the matchers does not contain an asynchronous method, call it faster.
@@ -482,11 +484,7 @@ class CoreEnforcer {
      * @return whether to allow the request and the reason rule.
      */
     enforceExSync(...rvals) {
-        if (rvals[0] instanceof enforceContext_1.EnforceContext) {
-            const enforceContext = rvals.shift();
-            return util_1.generatorRunSync(this.privateEnforce(false, true, enforceContext, ...rvals));
-        }
-        return util_1.generatorRunSync(this.privateEnforce(false, true, this.defaultEnforceContext, ...rvals));
+        return util_1.generatorRunSync(this.privateEnforce(false, true, ...rvals));
     }
     /**
      * Same as enforceSync. To be removed.
@@ -503,11 +501,7 @@ class CoreEnforcer {
      * @return whether to allow the request.
      */
     async enforce(...rvals) {
-        if (rvals[0] instanceof enforceContext_1.EnforceContext) {
-            const enforceContext = rvals.shift();
-            return util_1.generatorRunAsync(this.privateEnforce(true, false, enforceContext, ...rvals));
-        }
-        return util_1.generatorRunAsync(this.privateEnforce(true, false, this.defaultEnforceContext, ...rvals));
+        return util_1.generatorRunAsync(this.privateEnforce(true, false, ...rvals));
     }
     /**
      * enforce decides whether a "subject" can access a "object" with
@@ -518,11 +512,7 @@ class CoreEnforcer {
      * @return whether to allow the request and the reason rule.
      */
     async enforceEx(...rvals) {
-        if (rvals[0] instanceof enforceContext_1.EnforceContext) {
-            const enforceContext = rvals.shift();
-            return util_1.generatorRunAsync(this.privateEnforce(true, true, enforceContext, ...rvals));
-        }
-        return util_1.generatorRunAsync(this.privateEnforce(true, true, this.defaultEnforceContext, ...rvals));
+        return util_1.generatorRunAsync(this.privateEnforce(true, true, ...rvals));
     }
     /**
      * batchEnforce enforces each request and returns result in a bool array.

package/lib/{effect → cjs/effect}/index.js

@@ -20,7 +20,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./effector"), exports);

package/lib/{enforcer.d.ts → cjs/enforcer.d.ts}

@@ -6,12 +6,19 @@ import { Adapter } from './persist';
  */
 export declare class Enforcer extends ManagementEnforcer {
     /**
-     * initWithString initializes an enforcer with a model file and a policy file.
-     * @param modelString model file content
+     * initWithFile initializes an enforcer with a model file and a policy file.
+     * @param modelPath model file path
+     * @param policyPath policy file path
+     * @param lazyLoad lazyLoad whether to load policy at initial time
+     */
+    initWithFile(modelPath: string, policyPath: string, lazyLoad?: boolean): Promise<void>;
+    /**
+     * initWithFile initializes an enforcer with a model file and a policy file.
+     * @param modelPath model file path
      * @param policyString policy CSV string
      * @param lazyLoad whether to load policy at initial time
      */
-    initWithString(modelString: string, policyString: string, lazyLoad?: boolean): Promise<void>;
+    initWithString(modelPath: string, policyString: string, lazyLoad?: boolean): Promise<void>;
     /**
      * initWithAdapter initializes an enforcer with a database adapter.
      * @param modelPath model file path
@@ -61,16 +68,6 @@ export declare class Enforcer extends ManagementEnforcer {
      * @return succeeds or not.
      */
     addRoleForUser(user: string, role: string, domain?: string): Promise<boolean>;
-    /**
-     * addRoleForUserInDomain adds a role for a user.
-     * Returns false if the user already has the role (aka not affected).
-     *
-     * @param user the user.
-     * @param role the role.
-     * @param domain the domain.
-     * @return succeeds or not.
-     */
-    addRoleForUserInDomain(user: string, role: string, domain: string): Promise<boolean>;
     /**
      * deleteRoleForUser deletes a role for a user.
      * Returns false if the user does not have the role (aka not affected).
@@ -81,16 +78,6 @@ export declare class Enforcer extends ManagementEnforcer {
      * @return succeeds or not.
      */
     deleteRoleForUser(user: string, role: string, domain?: string): Promise<boolean>;
-    /**
-     * deleteRoleForUserInDomain deletes a role for a user.
-     * Returns false if the user does not have the role (aka not affected).
-     *
-     * @param user the user.
-     * @param role the role.
-     * @param domain the domain.
-     * @return succeeds or not.
-     */
-    deleteRoleForUserInDomain(user: string, role: string, domain?: string): Promise<boolean>;
     /**
      * deleteRolesForUser deletes all roles for a user.
      * Returns false if the user does not have any roles (aka not affected).
@@ -100,15 +87,6 @@ export declare class Enforcer extends ManagementEnforcer {
      * @return succeeds or not.
      */
     deleteRolesForUser(user: string, domain?: string): Promise<boolean>;
-    /**
-     * deleteRolesForUserInDomain deletes all roles for a user.
-     * Returns false if the user does not have any roles (aka not affected).
-     *
-     * @param user the user.
-     * @param domain the domain.
-     * @return succeeds or not.
-     */
-    deleteRolesForUserInDomain(user: string, domain?: string): Promise<boolean>;
     /**
      * deleteUser deletes a user.
      * Returns false if the user does not exist (aka not affected).
@@ -197,11 +175,6 @@ export declare class Enforcer extends ManagementEnforcer {
      * But getImplicitPermissionsForUser("alice") will get: [["admin", "data1", "read"], ["alice", "data2", "read"]].
      */
     getImplicitPermissionsForUser(user: string, ...domain: string[]): Promise<string[][]>;
-    /**
-     * getPermissionsForUserInDomain gets implicit permissions for a user or role.
-     * Compared to getPermissionsForUser(), this function retrieves permissions for inherited roles.
-     */
-    getPermissionsForUserInDomain(user: string, domain: string): Promise<string[][]>;
     /**
      * getImplicitUsersForRole gets implicit users that a role has.
      * Compared to getUsersForRole(), this function retrieves indirect users besides direct users.
@@ -213,6 +186,24 @@ export declare class Enforcer extends ManagementEnforcer {
      * But getImplicitUsersForRole("user") will get: ["role:admin", "alice"].
      */
     getImplicitUsersForRole(role: string, ...domain: string[]): Promise<string[]>;
+    /**
+     * getRolesForUserInDomain gets the roles that a user has inside a domain
+     * An alias for getRolesForUser with the domain params.
+     *
+     * @param name the user.
+     * @param domain the domain.
+     * @return the roles that the user has.
+     */
+    getRolesForUserInDomain(name: string, domain: string): Promise<string[]>;
+    /**
+     * getUsersForRoleInFomain gets the users that has a role inside a domain
+     * An alias for getUsesForRole with the domain params.
+     *
+     * @param name the role.
+     * @param domain the domain.
+     * @return the users that has the role.
+     */
+    getUsersForRoleInDomain(name: string, domain: string): Promise<string[]>;
     /**
      * getImplicitUsersForPermission gets implicit users for a permission.
      * For example:
@@ -227,11 +218,11 @@ export declare class Enforcer extends ManagementEnforcer {
 }
 export declare function newEnforcerWithClass<T extends Enforcer>(enforcer: new () => T, ...params: any[]): Promise<T>;
 /**
- * newEnforcer creates an enforcer via string or DB.
+ * newEnforcer creates an enforcer via file or DB.
  *
- * String:
+ * File:
  * ```js
- * const e = new Enforcer('content of basic_model.conf', 'content of basic_policy.csv');
+ * const e = new Enforcer('path/to/basic_model.conf', 'path/to/basic_policy.csv');
  * ```
  *
  * MySQL DB: