casbin 5.23.1 → 5.24.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.24.0](https://github.com/casbin/node-casbin/compare/v5.23.2...v5.24.0) (2023-02-17)
+
+
+### Features
+
+* add built-in FileSystem ([#430](https://github.com/casbin/node-casbin/issues/430)) ([999c34c](https://github.com/casbin/node-casbin/commit/999c34c620c7b8d608c7405550737bc0dfa974f5))
+
+## [5.23.2](https://github.com/casbin/node-casbin/compare/v5.23.1...v5.23.2) (2023-02-04)
+
+
+### Bug Fixes
+
+* fix typo in subject_priority_policy.csv ([#425](https://github.com/casbin/node-casbin/issues/425)) ([ada2543](https://github.com/casbin/node-casbin/commit/ada25436fe7baa37959e1d4f67a644e833e88656))
+
 ## [5.23.1](https://github.com/casbin/node-casbin/compare/v5.23.0...v5.23.1) (2023-02-02)
 
 

package/examples/subject_priority_policy.csv

@@ -2,7 +2,7 @@ p, root, data1, read, deny
 p, admin, data1, read, deny
 
 p, editor, data1, read, deny
-p, subscriber, data1, deny
+p, subscriber, data1, read, deny
 
 p, jane, data1, read, allow
 p, alice, data1, read, allow

package/lib/cjs/config.d.ts

@@ -1,3 +1,4 @@
+import { FileSystem } from './persist';
 export interface ConfigInterface {
     getString(key: string): string;
     getStrings(key: string): string[];
@@ -12,14 +13,22 @@ export declare class Config implements ConfigInterface {
     private static DEFAULT_COMMENT_SEM;
     private static DEFAULT_MULTI_LINE_SEPARATOR;
     private data;
+    private readonly fs?;
     private constructor();
     /**
      * newConfig create an empty configuration representation from file.
      *
      * @param confName the path of the model file.
      * @return the constructor of Config.
+     * @deprecated use {@link newConfigFromFile} instead.
      */
     static newConfig(confName: string): Config;
+    /**
+     * newConfigFromFile create an empty configuration representation from file.
+     * @param path the path of the model file.
+     * @param fs {@link FileSystem}
+     */
+    static newConfigFromFile(path: string, fs?: FileSystem): Config;
     /**
      * newConfigFromText create an empty configuration representation from text.
      *

package/lib/cjs/config.js

@@ -1,6 +1,4 @@
 "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");
@@ -14,20 +12,34 @@ exports.Config = void 0;
 // 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.
-const fs_1 = require("fs");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const persist_1 = require("./persist");
 class Config {
-    constructor() {
+    constructor(fs) {
         this.data = new Map();
+        if (fs) {
+            this.fs = fs;
+        }
     }
     /**
      * newConfig create an empty configuration representation from file.
      *
      * @param confName the path of the model file.
      * @return the constructor of Config.
+     * @deprecated use {@link newConfigFromFile} instead.
      */
     static newConfig(confName) {
-        const config = new Config();
-        config.parse(confName);
+        return this.newConfigFromFile(confName);
+    }
+    /**
+     * newConfigFromFile create an empty configuration representation from file.
+     * @param path the path of the model file.
+     * @param fs {@link FileSystem}
+     */
+    static newConfigFromFile(path, fs) {
+        const config = new Config(fs);
+        config.parse(path);
         return config;
     }
     /**
@@ -62,8 +74,8 @@ class Config {
         }
     }
     parse(path) {
-        const buf = fs_1.readFileSync(path);
-        this.parseBuffer(buf);
+        const body = (this.fs ? this.fs : persist_1.mustGetDefaultFileSystem()).readFileSync(path);
+        this.parseBuffer(Buffer.isBuffer(body) ? body : Buffer.from(body));
     }
     parseBuffer(buf) {
         const lines = buf

package/lib/cjs/coreEnforcer.d.ts

@@ -3,6 +3,7 @@ import { FunctionMap, Model, PolicyOp } from './model';
 import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter, WatcherEx } from './persist';
 import { RoleManager } from './rbac';
 import { MatchingFunc } from './rbac';
+import { FileSystem } from './persist';
 /**
  * CoreEnforcer defines the core functionality of an enforcer.
  */
@@ -20,6 +21,16 @@ export declare class CoreEnforcer {
     protected autoSave: boolean;
     protected autoBuildRoleLinks: boolean;
     protected autoNotifyWatcher: boolean;
+    protected fs?: FileSystem;
+    /**
+     * setFileSystem sets a file system to read the model file or the policy file.
+     * @param fs {@link FileSystem}
+     */
+    setFileSystem(fs: FileSystem): void;
+    /**
+     * getFileSystem gets the file system,
+     */
+    getFileSystem(): FileSystem | undefined;
     private getExpression;
     /**
      * loadModel reloads the model from the model CONF file.

package/lib/cjs/coreEnforcer.js

@@ -35,6 +35,19 @@ class CoreEnforcer {
         this.autoBuildRoleLinks = true;
         this.autoNotifyWatcher = true;
     }
+    /**
+     * setFileSystem sets a file system to read the model file or the policy file.
+     * @param fs {@link FileSystem}
+     */
+    setFileSystem(fs) {
+        this.fs = fs;
+    }
+    /**
+     * getFileSystem gets the file system,
+     */
+    getFileSystem() {
+        return this.fs;
+    }
     getExpression(asyncCompile, exp) {
         const matcherKey = `${asyncCompile ? 'ASYNC[' : 'SYNC['}${exp}]`;
         expression_eval_1.addBinaryOp('in', 1, util_1.customIn);
@@ -52,8 +65,7 @@ class CoreEnforcer {
      * so the policy is invalidated and needs to be reloaded by calling LoadPolicy().
      */
     loadModel() {
-        this.model = model_1.newModel();
-        this.model.loadModel(this.modelPath);
+        this.model = model_1.newModelFromFile(this.modelPath, this.fs);
         this.model.printModel();
     }
     /**

package/lib/cjs/enforcer.js

@@ -30,7 +30,7 @@ class Enforcer extends managementEnforcer_1.ManagementEnforcer {
      * @param lazyLoad lazyLoad whether to load policy at initial time
      */
     async initWithFile(modelPath, policyPath, lazyLoad = false) {
-        const a = new persist_1.FileAdapter(policyPath);
+        const a = new persist_1.FileAdapter(policyPath, this.fs);
         await this.initWithAdapter(modelPath, a, lazyLoad);
     }
     /**
@@ -50,7 +50,7 @@ class Enforcer extends managementEnforcer_1.ManagementEnforcer {
      * @param lazyLoad whether to load policy at initial time
      */
     async initWithAdapter(modelPath, adapter, lazyLoad = false) {
-        const m = model_1.newModel(modelPath, '');
+        const m = model_1.newModelFromFile(modelPath, this.fs);
         await this.initWithModelAndAdapter(m, adapter, lazyLoad);
         this.modelPath = modelPath;
     }

package/lib/cjs/index.js

@@ -34,10 +34,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 };
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Util = void 0;
 const Util = __importStar(require("./util"));
 exports.Util = Util;
+const persist_1 = require("./persist");
 __exportStar(require("./config"), exports);
 __exportStar(require("./enforcer"), exports);
 __exportStar(require("./cachedEnforcer"), exports);
@@ -48,3 +50,16 @@ __exportStar(require("./persist"), exports);
 __exportStar(require("./rbac"), exports);
 __exportStar(require("./log"), exports);
 __exportStar(require("./frontend"), exports);
+if (typeof process !== 'undefined' && ((_a = process === null || process === void 0 ? void 0 : process.versions) === null || _a === void 0 ? void 0 : _a.node)) {
+    const requireFunc = typeof __non_webpack_require__ === 'function' ? __non_webpack_require__ : require;
+    const fs = requireFunc('fs');
+    const defaultFileSystem = {
+        readFileSync(path, encoding) {
+            return fs.readFileSync(path, { encoding });
+        },
+        writeFileSync(path, text, encoding) {
+            return fs.writeFileSync(path, text, encoding);
+        },
+    };
+    persist_1.setDefaultFileSystem(defaultFileSystem);
+}

package/lib/cjs/model/model.d.ts

@@ -1,6 +1,7 @@
 import * as rbac from '../rbac';
 import { ConfigInterface } from '../config';
 import { Assertion } from './assertion';
+import { FileSystem } from '../persist/fileSystem';
 export declare const sectionNameMap: {
     [index: string]: string;
 };
@@ -19,7 +20,19 @@ export declare class Model {
     private getKeySuffix;
     private loadSection;
     addDef(sec: string, key: string, value: string): boolean;
-    loadModel(path: string): void;
+    /**
+     * loadModel loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     * @deprecated {@link loadModelFromFile}
+     */
+    loadModel(path: string, fs?: FileSystem): void;
+    /**
+     * loadModelFromFile loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     */
+    loadModelFromFile(path: string, fs?: FileSystem): void;
     loadModelFromText(text: string): void;
     loadModelFromConfig(cfg: ConfigInterface): void;
     private hasSection;
@@ -64,7 +77,7 @@ export declare function newModel(...text: string[]): Model;
 /**
  * newModelFromFile creates a model from a .CONF file.
  */
-export declare function newModelFromFile(path: string): Model;
+export declare function newModelFromFile(path: string, fs?: FileSystem): Model;
 /**
  * newModelFromString creates a model from a string which contains model text.
  */

package/lib/cjs/model/model.js

@@ -123,9 +123,22 @@ class Model {
         }
         return true;
     }
-    // loadModel loads the model from model CONF file.
-    loadModel(path) {
-        const cfg = config_1.Config.newConfig(path);
+    /**
+     * loadModel loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     * @deprecated {@link loadModelFromFile}
+     */
+    loadModel(path, fs) {
+        this.loadModelFromFile(path, fs);
+    }
+    /**
+     * loadModelFromFile loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     */
+    loadModelFromFile(path, fs) {
+        const cfg = config_1.Config.newConfigFromFile(path, fs);
         this.loadModelFromConfig(cfg);
     }
     // loadModelFromText loads the model from the text.
@@ -532,7 +545,7 @@ function newModel(...text) {
     const m = new Model();
     if (text.length === 2) {
         if (text[0] !== '') {
-            m.loadModel(text[0]);
+            m.loadModelFromFile(text[0]);
         }
     }
     else if (text.length === 1) {
@@ -547,9 +560,11 @@ exports.newModel = newModel;
 /**
  * newModelFromFile creates a model from a .CONF file.
  */
-function newModelFromFile(path) {
+function newModelFromFile(path, fs) {
     const m = new Model();
-    m.loadModel(path);
+    if (path) {
+        m.loadModelFromFile(path, fs);
+    }
     return m;
 }
 exports.newModelFromFile = newModelFromFile;

package/lib/cjs/persist/fileAdapter.d.ts

@@ -1,16 +1,20 @@
 import { Adapter } from './adapter';
 import { Model } from '../model';
+import { FileSystem } from './fileSystem';
 /**
  * FileAdapter is the file adapter for Casbin.
  * It can load policy from file or save policy to file.
  */
 export declare class FileAdapter implements Adapter {
     readonly filePath: string;
+    protected readonly fs?: FileSystem;
     /**
      * FileAdapter is the constructor for FileAdapter.
-     * @param {string} filePath filePath the path of the policy file.
+     *
+     * @param filePath filePath the path of the policy file.
+     * @param fs {@link FileSystem}
      */
-    constructor(filePath: string);
+    constructor(filePath: string, fs?: FileSystem);
     loadPolicy(model: Model): Promise<void>;
     private loadPolicyFile;
     /**

package/lib/cjs/persist/fileAdapter.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileAdapter = void 0;
 const helper_1 = require("./helper");
 const util_1 = require("../util");
+const fileSystem_1 = require("./fileSystem");
 /**
  * FileAdapter is the file adapter for Casbin.
  * It can load policy from file or save policy to file.
@@ -10,10 +11,13 @@ const util_1 = require("../util");
 class FileAdapter {
     /**
      * FileAdapter is the constructor for FileAdapter.
-     * @param {string} filePath filePath the path of the policy file.
+     *
+     * @param filePath filePath the path of the policy file.
+     * @param fs {@link FileSystem}
      */
-    constructor(filePath) {
+    constructor(filePath, fs) {
         this.filePath = filePath;
+        this.fs = fs;
     }
     async loadPolicy(model) {
         if (!this.filePath) {
@@ -23,7 +27,7 @@ class FileAdapter {
         await this.loadPolicyFile(model, helper_1.Helper.loadPolicyLine);
     }
     async loadPolicyFile(model, handler) {
-        const bodyBuf = await util_1.readFile(this.filePath);
+        const bodyBuf = await (this.fs ? this.fs : fileSystem_1.mustGetDefaultFileSystem()).readFileSync(this.filePath);
         const lines = bodyBuf.toString().split('\n');
         lines.forEach((n, index) => {
             if (!n) {
@@ -67,7 +71,7 @@ class FileAdapter {
         return true;
     }
     async savePolicyFile(text) {
-        await util_1.writeFile(this.filePath, text);
+        (this.fs ? this.fs : fileSystem_1.mustGetDefaultFileSystem()).writeFileSync(this.filePath, text);
     }
     /**
      * addPolicy adds a policy rule to the storage.

package/lib/cjs/persist/fileSystem.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+export interface FileSystem {
+    readFileSync(path: string, encoding?: string): Buffer | string;
+    writeFileSync(path: string, text: string, encoding?: string): void;
+}
+export declare const setDefaultFileSystem: (fs?: FileSystem | undefined) => void;
+export declare const getDefaultFileSystem: () => FileSystem | undefined;
+export declare const mustGetDefaultFileSystem: () => FileSystem;

package/lib/cjs/persist/fileSystem.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mustGetDefaultFileSystem = exports.getDefaultFileSystem = exports.setDefaultFileSystem = void 0;
+let defaultFileSystem = undefined;
+const ErrorNoFileSystem = new Error('please set the default FileSystem by call the setDefaultFileSystem');
+exports.setDefaultFileSystem = (fs) => {
+    defaultFileSystem = fs;
+};
+exports.getDefaultFileSystem = () => defaultFileSystem;
+exports.mustGetDefaultFileSystem = () => {
+    if (defaultFileSystem) {
+        return defaultFileSystem;
+    }
+    throw ErrorNoFileSystem;
+};

package/lib/cjs/persist/index.d.ts

@@ -9,3 +9,4 @@ export * from './defaultFilteredAdapter';
 export * from './batchAdapter';
 export * from './batchFileAdapter';
 export * from './updatableAdapter';
+export * from './fileSystem';

package/lib/cjs/persist/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./defaultFilteredAdapter"), exports);
 __exportStar(require("./batchAdapter"), exports);
 __exportStar(require("./batchFileAdapter"), exports);
 __exportStar(require("./updatableAdapter"), exports);
+__exportStar(require("./fileSystem"), exports);

package/lib/cjs/util/util.js

@@ -12,30 +12,11 @@
 // 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.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bracketCompatible = exports.customIn = exports.deepCopy = exports.generatorRunAsync = exports.generatorRunSync = exports.getEvalValue = exports.replaceEval = exports.hasEval = exports.writeFile = exports.readFile = exports.setEquals = exports.paramsToString = exports.arrayToString = exports.arrayRemoveDuplicates = exports.array2DEquals = exports.arrayEquals = exports.removeComments = exports.escapeAssertion = void 0;
-const fs = __importStar(require("fs"));
 // escapeAssertion escapes the dots in the assertion,
 // because the expression evaluation doesn't support such variable names.
+const persist_1 = require("../persist");
 function escapeAssertion(s) {
     s = s.replace(/r\./g, 'r_');
     s = s.replace(/p\./g, 'p_');
@@ -100,25 +81,29 @@ function setEquals(a, b) {
 exports.setEquals = setEquals;
 // readFile return a promise for readFile.
 function readFile(path, encoding) {
+    const fs = persist_1.mustGetDefaultFileSystem();
     return new Promise((resolve, reject) => {
-        fs.readFile(path, encoding || 'utf8', (error, data) => {
-            if (error) {
-                reject(error);
-            }
-            resolve(data);
-        });
+        try {
+            fs.readFileSync(path, encoding || 'utf8');
+            resolve();
+        }
+        catch (e) {
+            reject(e);
+        }
     });
 }
 exports.readFile = readFile;
 // writeFile return a promise for writeFile.
 function writeFile(path, file, encoding) {
+    const fs = persist_1.mustGetDefaultFileSystem();
     return new Promise((resolve, reject) => {
-        fs.writeFile(path, file, encoding || 'utf8', (error) => {
-            if (error) {
-                reject(error);
-            }
-            resolve(true);
-        });
+        try {
+            fs.writeFileSync(path, file, encoding || 'utf-8');
+            resolve();
+        }
+        catch (e) {
+            reject(e);
+        }
     });
 }
 exports.writeFile = writeFile;

package/lib/esm/config.d.ts

@@ -1,3 +1,4 @@
+import { FileSystem } from './persist';
 export interface ConfigInterface {
     getString(key: string): string;
     getStrings(key: string): string[];
@@ -12,14 +13,22 @@ export declare class Config implements ConfigInterface {
     private static DEFAULT_COMMENT_SEM;
     private static DEFAULT_MULTI_LINE_SEPARATOR;
     private data;
+    private readonly fs?;
     private constructor();
     /**
      * newConfig create an empty configuration representation from file.
      *
      * @param confName the path of the model file.
      * @return the constructor of Config.
+     * @deprecated use {@link newConfigFromFile} instead.
      */
     static newConfig(confName: string): Config;
+    /**
+     * newConfigFromFile create an empty configuration representation from file.
+     * @param path the path of the model file.
+     * @param fs {@link FileSystem}
+     */
+    static newConfigFromFile(path: string, fs?: FileSystem): Config;
     /**
      * newConfigFromText create an empty configuration representation from text.
      *

package/lib/esm/config.js

@@ -11,20 +11,32 @@
 // 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.
-import { readFileSync } from 'fs';
+import { mustGetDefaultFileSystem } from './persist';
 export class Config {
-    constructor() {
+    constructor(fs) {
         this.data = new Map();
+        if (fs) {
+            this.fs = fs;
+        }
     }
     /**
      * newConfig create an empty configuration representation from file.
      *
      * @param confName the path of the model file.
      * @return the constructor of Config.
+     * @deprecated use {@link newConfigFromFile} instead.
      */
     static newConfig(confName) {
-        const config = new Config();
-        config.parse(confName);
+        return this.newConfigFromFile(confName);
+    }
+    /**
+     * newConfigFromFile create an empty configuration representation from file.
+     * @param path the path of the model file.
+     * @param fs {@link FileSystem}
+     */
+    static newConfigFromFile(path, fs) {
+        const config = new Config(fs);
+        config.parse(path);
         return config;
     }
     /**
@@ -59,8 +71,8 @@ export class Config {
         }
     }
     parse(path) {
-        const buf = readFileSync(path);
-        this.parseBuffer(buf);
+        const body = (this.fs ? this.fs : mustGetDefaultFileSystem()).readFileSync(path);
+        this.parseBuffer(Buffer.isBuffer(body) ? body : Buffer.from(body));
     }
     parseBuffer(buf) {
         const lines = buf

package/lib/esm/coreEnforcer.d.ts

@@ -3,6 +3,7 @@ import { FunctionMap, Model, PolicyOp } from './model';
 import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter, WatcherEx } from './persist';
 import { RoleManager } from './rbac';
 import { MatchingFunc } from './rbac';
+import { FileSystem } from './persist';
 /**
  * CoreEnforcer defines the core functionality of an enforcer.
  */
@@ -20,6 +21,16 @@ export declare class CoreEnforcer {
     protected autoSave: boolean;
     protected autoBuildRoleLinks: boolean;
     protected autoNotifyWatcher: boolean;
+    protected fs?: FileSystem;
+    /**
+     * setFileSystem sets a file system to read the model file or the policy file.
+     * @param fs {@link FileSystem}
+     */
+    setFileSystem(fs: FileSystem): void;
+    /**
+     * getFileSystem gets the file system,
+     */
+    getFileSystem(): FileSystem | undefined;
     private getExpression;
     /**
      * loadModel reloads the model from the model CONF file.

package/lib/esm/coreEnforcer.js

@@ -13,7 +13,7 @@
 // limitations under the License.
 import { compile, compileAsync, addBinaryOp } from 'expression-eval';
 import { DefaultEffector, Effect } from './effect';
-import { FunctionMap, newModel } from './model';
+import { FunctionMap, newModelFromFile } from './model';
 import { DefaultRoleManager } from './rbac';
 import { escapeAssertion, generateGFunction, generateSyncedGFunction, getEvalValue, hasEval, replaceEval, generatorRunSync, generatorRunAsync, customIn, bracketCompatible, } from './util';
 import { getLogger, logPrint } from './log';
@@ -32,6 +32,19 @@ export class CoreEnforcer {
         this.autoBuildRoleLinks = true;
         this.autoNotifyWatcher = true;
     }
+    /**
+     * setFileSystem sets a file system to read the model file or the policy file.
+     * @param fs {@link FileSystem}
+     */
+    setFileSystem(fs) {
+        this.fs = fs;
+    }
+    /**
+     * getFileSystem gets the file system,
+     */
+    getFileSystem() {
+        return this.fs;
+    }
     getExpression(asyncCompile, exp) {
         const matcherKey = `${asyncCompile ? 'ASYNC[' : 'SYNC['}${exp}]`;
         addBinaryOp('in', 1, customIn);
@@ -49,8 +62,7 @@ export class CoreEnforcer {
      * so the policy is invalidated and needs to be reloaded by calling LoadPolicy().
      */
     loadModel() {
-        this.model = newModel();
-        this.model.loadModel(this.modelPath);
+        this.model = newModelFromFile(this.modelPath, this.fs);
         this.model.printModel();
     }
     /**

package/lib/esm/enforcer.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { ManagementEnforcer } from './managementEnforcer';
-import { newModel } from './model';
+import { newModelFromFile } from './model';
 import { FileAdapter, StringAdapter } from './persist';
 import { getLogger } from './log';
 import { arrayRemoveDuplicates } from './util';
@@ -27,7 +27,7 @@ export class Enforcer extends ManagementEnforcer {
      * @param lazyLoad lazyLoad whether to load policy at initial time
      */
     async initWithFile(modelPath, policyPath, lazyLoad = false) {
-        const a = new FileAdapter(policyPath);
+        const a = new FileAdapter(policyPath, this.fs);
         await this.initWithAdapter(modelPath, a, lazyLoad);
     }
     /**
@@ -47,7 +47,7 @@ export class Enforcer extends ManagementEnforcer {
      * @param lazyLoad whether to load policy at initial time
      */
     async initWithAdapter(modelPath, adapter, lazyLoad = false) {
-        const m = newModel(modelPath, '');
+        const m = newModelFromFile(modelPath, this.fs);
         await this.initWithModelAndAdapter(m, adapter, lazyLoad);
         this.modelPath = modelPath;
     }

package/lib/esm/index.js

@@ -11,7 +11,9 @@
 // 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.
+var _a;
 import * as Util from './util';
+import { setDefaultFileSystem } from './persist';
 export * from './config';
 export * from './enforcer';
 export * from './cachedEnforcer';
@@ -23,3 +25,16 @@ export * from './rbac';
 export * from './log';
 export * from './frontend';
 export { Util };
+if (typeof process !== 'undefined' && ((_a = process === null || process === void 0 ? void 0 : process.versions) === null || _a === void 0 ? void 0 : _a.node)) {
+    const requireFunc = typeof __non_webpack_require__ === 'function' ? __non_webpack_require__ : require;
+    const fs = requireFunc('fs');
+    const defaultFileSystem = {
+        readFileSync(path, encoding) {
+            return fs.readFileSync(path, { encoding });
+        },
+        writeFileSync(path, text, encoding) {
+            return fs.writeFileSync(path, text, encoding);
+        },
+    };
+    setDefaultFileSystem(defaultFileSystem);
+}

package/lib/esm/model/model.d.ts

@@ -1,6 +1,7 @@
 import * as rbac from '../rbac';
 import { ConfigInterface } from '../config';
 import { Assertion } from './assertion';
+import { FileSystem } from '../persist/fileSystem';
 export declare const sectionNameMap: {
     [index: string]: string;
 };
@@ -19,7 +20,19 @@ export declare class Model {
     private getKeySuffix;
     private loadSection;
     addDef(sec: string, key: string, value: string): boolean;
-    loadModel(path: string): void;
+    /**
+     * loadModel loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     * @deprecated {@link loadModelFromFile}
+     */
+    loadModel(path: string, fs?: FileSystem): void;
+    /**
+     * loadModelFromFile loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     */
+    loadModelFromFile(path: string, fs?: FileSystem): void;
     loadModelFromText(text: string): void;
     loadModelFromConfig(cfg: ConfigInterface): void;
     private hasSection;
@@ -64,7 +77,7 @@ export declare function newModel(...text: string[]): Model;
 /**
  * newModelFromFile creates a model from a .CONF file.
  */
-export declare function newModelFromFile(path: string): Model;
+export declare function newModelFromFile(path: string, fs?: FileSystem): Model;
 /**
  * newModelFromString creates a model from a string which contains model text.
  */

package/lib/esm/model/model.js

@@ -101,9 +101,22 @@ export class Model {
         }
         return true;
     }
-    // loadModel loads the model from model CONF file.
-    loadModel(path) {
-        const cfg = Config.newConfig(path);
+    /**
+     * loadModel loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     * @deprecated {@link loadModelFromFile}
+     */
+    loadModel(path, fs) {
+        this.loadModelFromFile(path, fs);
+    }
+    /**
+     * loadModelFromFile loads the model from model CONF file.
+     * @param path the model file path
+     * @param fs {@link FileSystem}
+     */
+    loadModelFromFile(path, fs) {
+        const cfg = Config.newConfigFromFile(path, fs);
         this.loadModelFromConfig(cfg);
     }
     // loadModelFromText loads the model from the text.
@@ -509,7 +522,7 @@ export function newModel(...text) {
     const m = new Model();
     if (text.length === 2) {
         if (text[0] !== '') {
-            m.loadModel(text[0]);
+            m.loadModelFromFile(text[0]);
         }
     }
     else if (text.length === 1) {
@@ -523,9 +536,11 @@ export function newModel(...text) {
 /**
  * newModelFromFile creates a model from a .CONF file.
  */
-export function newModelFromFile(path) {
+export function newModelFromFile(path, fs) {
     const m = new Model();
-    m.loadModel(path);
+    if (path) {
+        m.loadModelFromFile(path, fs);
+    }
     return m;
 }
 /**

package/lib/esm/persist/fileAdapter.d.ts

@@ -1,16 +1,20 @@
 import { Adapter } from './adapter';
 import { Model } from '../model';
+import { FileSystem } from './fileSystem';
 /**
  * FileAdapter is the file adapter for Casbin.
  * It can load policy from file or save policy to file.
  */
 export declare class FileAdapter implements Adapter {
     readonly filePath: string;
+    protected readonly fs?: FileSystem;
     /**
      * FileAdapter is the constructor for FileAdapter.
-     * @param {string} filePath filePath the path of the policy file.
+     *
+     * @param filePath filePath the path of the policy file.
+     * @param fs {@link FileSystem}
      */
-    constructor(filePath: string);
+    constructor(filePath: string, fs?: FileSystem);
     loadPolicy(model: Model): Promise<void>;
     private loadPolicyFile;
     /**

package/lib/esm/persist/fileAdapter.js

@@ -1,5 +1,6 @@
 import { Helper } from './helper';
-import { arrayToString, readFile, writeFile } from '../util';
+import { arrayToString } from '../util';
+import { mustGetDefaultFileSystem } from './fileSystem';
 /**
  * FileAdapter is the file adapter for Casbin.
  * It can load policy from file or save policy to file.
@@ -7,10 +8,13 @@ import { arrayToString, readFile, writeFile } from '../util';
 export class FileAdapter {
     /**
      * FileAdapter is the constructor for FileAdapter.
-     * @param {string} filePath filePath the path of the policy file.
+     *
+     * @param filePath filePath the path of the policy file.
+     * @param fs {@link FileSystem}
      */
-    constructor(filePath) {
+    constructor(filePath, fs) {
         this.filePath = filePath;
+        this.fs = fs;
     }
     async loadPolicy(model) {
         if (!this.filePath) {
@@ -20,7 +24,7 @@ export class FileAdapter {
         await this.loadPolicyFile(model, Helper.loadPolicyLine);
     }
     async loadPolicyFile(model, handler) {
-        const bodyBuf = await readFile(this.filePath);
+        const bodyBuf = await (this.fs ? this.fs : mustGetDefaultFileSystem()).readFileSync(this.filePath);
         const lines = bodyBuf.toString().split('\n');
         lines.forEach((n, index) => {
             if (!n) {
@@ -64,7 +68,7 @@ export class FileAdapter {
         return true;
     }
     async savePolicyFile(text) {
-        await writeFile(this.filePath, text);
+        (this.fs ? this.fs : mustGetDefaultFileSystem()).writeFileSync(this.filePath, text);
     }
     /**
      * addPolicy adds a policy rule to the storage.

package/lib/esm/persist/fileSystem.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+export interface FileSystem {
+    readFileSync(path: string, encoding?: string): Buffer | string;
+    writeFileSync(path: string, text: string, encoding?: string): void;
+}
+export declare const setDefaultFileSystem: (fs?: FileSystem | undefined) => void;
+export declare const getDefaultFileSystem: () => FileSystem | undefined;
+export declare const mustGetDefaultFileSystem: () => FileSystem;

package/lib/esm/persist/fileSystem.js

@@ -0,0 +1,12 @@
+let defaultFileSystem = undefined;
+const ErrorNoFileSystem = new Error('please set the default FileSystem by call the setDefaultFileSystem');
+export const setDefaultFileSystem = (fs) => {
+    defaultFileSystem = fs;
+};
+export const getDefaultFileSystem = () => defaultFileSystem;
+export const mustGetDefaultFileSystem = () => {
+    if (defaultFileSystem) {
+        return defaultFileSystem;
+    }
+    throw ErrorNoFileSystem;
+};

package/lib/esm/persist/index.d.ts

@@ -9,3 +9,4 @@ export * from './defaultFilteredAdapter';
 export * from './batchAdapter';
 export * from './batchFileAdapter';
 export * from './updatableAdapter';
+export * from './fileSystem';

package/lib/esm/persist/index.js

@@ -9,3 +9,4 @@ export * from './defaultFilteredAdapter';
 export * from './batchAdapter';
 export * from './batchFileAdapter';
 export * from './updatableAdapter';
+export * from './fileSystem';

package/lib/esm/util/util.js

@@ -11,9 +11,9 @@
 // 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.
-import * as fs from 'fs';
 // escapeAssertion escapes the dots in the assertion,
 // because the expression evaluation doesn't support such variable names.
+import { mustGetDefaultFileSystem } from '../persist';
 function escapeAssertion(s) {
     s = s.replace(/r\./g, 'r_');
     s = s.replace(/p\./g, 'p_');
@@ -70,24 +70,28 @@ function setEquals(a, b) {
 }
 // readFile return a promise for readFile.
 function readFile(path, encoding) {
+    const fs = mustGetDefaultFileSystem();
     return new Promise((resolve, reject) => {
-        fs.readFile(path, encoding || 'utf8', (error, data) => {
-            if (error) {
-                reject(error);
-            }
-            resolve(data);
-        });
+        try {
+            fs.readFileSync(path, encoding || 'utf8');
+            resolve();
+        }
+        catch (e) {
+            reject(e);
+        }
     });
 }
 // writeFile return a promise for writeFile.
 function writeFile(path, file, encoding) {
+    const fs = mustGetDefaultFileSystem();
     return new Promise((resolve, reject) => {
-        fs.writeFile(path, file, encoding || 'utf8', (error) => {
-            if (error) {
-                reject(error);
-            }
-            resolve(true);
-        });
+        try {
+            fs.writeFileSync(path, file, encoding || 'utf-8');
+            resolve();
+        }
+        catch (e) {
+            reject(e);
+        }
     });
 }
 const evalRegG = new RegExp(/\beval\(([^),]*)\)/g);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "casbin",
-  "version": "5.23.1",
+  "version": "5.24.0",
   "description": "An authorization library that supports access control models like ACL, RBAC, ABAC in Node.JS",
   "main": "lib/cjs/index.js",
   "typings": "lib/cjs/index.d.ts",