casbin 5.35.0 → 5.37.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.37.0](https://github.com/casbin/node-casbin/compare/v5.36.0...v5.37.0) (2025-01-10)
+
+
+### Features
+
+* use empty array [] as reason for enforceEx() ([#496](https://github.com/casbin/node-casbin/issues/496)) ([c951a8f](https://github.com/casbin/node-casbin/commit/c951a8fd6afb70ecdbbf76e3424ec5107133e254))
+
+# [5.36.0](https://github.com/casbin/node-casbin/compare/v5.35.0...v5.36.0) (2024-11-22)
+
+
+### Features
+
+* add BracketAwareCsvParser to parse CSV file better ([#494](https://github.com/casbin/node-casbin/issues/494)) ([4c73883](https://github.com/casbin/node-casbin/commit/4c738831ebbf71f8f3a6ccac8495644c09a5e5dd))
+
 # [5.35.0](https://github.com/casbin/node-casbin/compare/v5.34.0...v5.35.0) (2024-11-20)
 
 

package/lib/cjs/coreEnforcer.js

@@ -352,7 +352,7 @@ class CoreEnforcer {
         }
     }
     *privateEnforce(asyncCompile = true, explain = false, matcher, enforceContext = new enforceContext_1.EnforceContext('r', 'p', 'e', 'm'), ...rvals) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         if (!this.enabled) {
             return true;
         }
@@ -504,7 +504,7 @@ class CoreEnforcer {
             if (explainIndex === -1) {
                 return [res, []];
             }
-            return [res, p === null || p === void 0 ? void 0 : p.policy[explainIndex]];
+            return [res, ((_k = p === null || p === void 0 ? void 0 : p.policy) === null || _k === void 0 ? void 0 : _k[explainIndex]) || []];
         }
         return res;
     }

package/lib/cjs/persist/fileAdapter.js

@@ -29,11 +29,11 @@ class FileAdapter {
     async loadPolicyFile(model, handler) {
         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) {
+        lines.forEach((line) => {
+            if (!line || line.trim().startsWith('#')) {
                 return;
             }
-            handler(n, model);
+            handler(line, model);
         });
     }
     /**

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

@@ -1,4 +1,21 @@
 import { Model } from '../model';
+export interface IPolicyParser {
+    parse(line: string): string[][] | null;
+}
+export declare class BasicCsvParser implements IPolicyParser {
+    parse(line: string): string[][] | null;
+}
+export declare class BracketAwareCsvParser implements IPolicyParser {
+    private readonly baseParser;
+    constructor(baseParser?: IPolicyParser);
+    parse(line: string): string[][] | null;
+}
+export declare class PolicyLoader {
+    private readonly parser;
+    constructor(parser?: IPolicyParser);
+    loadPolicyLine(line: string, model: Model): void;
+}
 export declare class Helper {
+    private static readonly policyLoader;
     static loadPolicyLine(line: string, model: Model): void;
 }

package/lib/cjs/persist/helper.js

@@ -1,21 +1,67 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Helper = void 0;
+exports.Helper = exports.PolicyLoader = exports.BracketAwareCsvParser = exports.BasicCsvParser = void 0;
 const sync_1 = require("csv-parse/sync");
-class Helper {
-    static loadPolicyLine(line, model) {
+class BasicCsvParser {
+    parse(line) {
         if (!line || line.trimStart().charAt(0) === '#') {
-            return;
+            return null;
         }
-        const tokens = sync_1.parse(line, {
+        return sync_1.parse(line, {
             delimiter: ',',
             skip_empty_lines: true,
             trim: true,
+            relax_quotes: true,
         });
+    }
+}
+exports.BasicCsvParser = BasicCsvParser;
+class BracketAwareCsvParser {
+    constructor(baseParser = new BasicCsvParser()) {
+        this.baseParser = baseParser;
+    }
+    parse(line) {
+        const rawTokens = this.baseParser.parse(line);
+        if (!rawTokens || !rawTokens[0]) {
+            return null;
+        }
+        const tokens = rawTokens[0];
+        const processedTokens = [];
+        let currentToken = '';
+        let bracketCount = 0;
+        for (const token of tokens) {
+            for (const char of token) {
+                if (char === '(')
+                    bracketCount++;
+                else if (char === ')')
+                    bracketCount--;
+            }
+            currentToken += (currentToken ? ',' : '') + token;
+            if (bracketCount === 0) {
+                processedTokens.push(currentToken);
+                currentToken = '';
+            }
+        }
+        if (bracketCount !== 0) {
+            throw new Error(`Unmatched brackets in policy line: ${line}`);
+        }
+        return processedTokens.length > 0 ? [processedTokens] : null;
+    }
+}
+exports.BracketAwareCsvParser = BracketAwareCsvParser;
+class PolicyLoader {
+    constructor(parser = new BracketAwareCsvParser()) {
+        this.parser = parser;
+    }
+    loadPolicyLine(line, model) {
+        const tokens = this.parser.parse(line);
         if (!tokens || !tokens[0]) {
             return;
         }
-        const key = tokens[0][0];
+        let key = tokens[0][0].trim();
+        if (key.startsWith('"') && key.endsWith('"')) {
+            key = key.slice(1, -1);
+        }
         const sec = key.substring(0, 1);
         const item = model.model.get(sec);
         if (!item) {
@@ -25,7 +71,20 @@ class Helper {
         if (!policy) {
             return;
         }
-        policy.policy.push(tokens[0].slice(1));
+        const values = tokens[0].slice(1).map((v) => {
+            if (v.startsWith('"') && v.endsWith('"')) {
+                v = v.slice(1, -1);
+            }
+            return v.replace(/""/g, '"').trim();
+        });
+        policy.policy.push(values);
+    }
+}
+exports.PolicyLoader = PolicyLoader;
+class Helper {
+    static loadPolicyLine(line, model) {
+        Helper.policyLoader.loadPolicyLine(line, model);
     }
 }
 exports.Helper = Helper;
+Helper.policyLoader = new PolicyLoader();

package/lib/esm/coreEnforcer.js

@@ -349,7 +349,7 @@ export class CoreEnforcer {
         }
     }
     *privateEnforce(asyncCompile = true, explain = false, matcher, enforceContext = new EnforceContext('r', 'p', 'e', 'm'), ...rvals) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         if (!this.enabled) {
             return true;
         }
@@ -501,7 +501,7 @@ export class CoreEnforcer {
             if (explainIndex === -1) {
                 return [res, []];
             }
-            return [res, p === null || p === void 0 ? void 0 : p.policy[explainIndex]];
+            return [res, ((_k = p === null || p === void 0 ? void 0 : p.policy) === null || _k === void 0 ? void 0 : _k[explainIndex]) || []];
         }
         return res;
     }

package/lib/esm/persist/fileAdapter.js

@@ -26,11 +26,11 @@ export class FileAdapter {
     async loadPolicyFile(model, handler) {
         const bodyBuf = await (this.fs ? this.fs : mustGetDefaultFileSystem()).readFileSync(this.filePath);
         const lines = bodyBuf.toString().split('\n');
-        lines.forEach((n, index) => {
-            if (!n) {
+        lines.forEach((line) => {
+            if (!line || line.trim().startsWith('#')) {
                 return;
             }
-            handler(n, model);
+            handler(line, model);
         });
     }
     /**

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

@@ -1,4 +1,21 @@
 import { Model } from '../model';
+export interface IPolicyParser {
+    parse(line: string): string[][] | null;
+}
+export declare class BasicCsvParser implements IPolicyParser {
+    parse(line: string): string[][] | null;
+}
+export declare class BracketAwareCsvParser implements IPolicyParser {
+    private readonly baseParser;
+    constructor(baseParser?: IPolicyParser);
+    parse(line: string): string[][] | null;
+}
+export declare class PolicyLoader {
+    private readonly parser;
+    constructor(parser?: IPolicyParser);
+    loadPolicyLine(line: string, model: Model): void;
+}
 export declare class Helper {
+    private static readonly policyLoader;
     static loadPolicyLine(line: string, model: Model): void;
 }

package/lib/esm/persist/helper.js

@@ -1,18 +1,62 @@
 import { parse } from 'csv-parse/sync';
-export class Helper {
-    static loadPolicyLine(line, model) {
+export class BasicCsvParser {
+    parse(line) {
         if (!line || line.trimStart().charAt(0) === '#') {
-            return;
+            return null;
         }
-        const tokens = parse(line, {
+        return parse(line, {
             delimiter: ',',
             skip_empty_lines: true,
             trim: true,
+            relax_quotes: true,
         });
+    }
+}
+export class BracketAwareCsvParser {
+    constructor(baseParser = new BasicCsvParser()) {
+        this.baseParser = baseParser;
+    }
+    parse(line) {
+        const rawTokens = this.baseParser.parse(line);
+        if (!rawTokens || !rawTokens[0]) {
+            return null;
+        }
+        const tokens = rawTokens[0];
+        const processedTokens = [];
+        let currentToken = '';
+        let bracketCount = 0;
+        for (const token of tokens) {
+            for (const char of token) {
+                if (char === '(')
+                    bracketCount++;
+                else if (char === ')')
+                    bracketCount--;
+            }
+            currentToken += (currentToken ? ',' : '') + token;
+            if (bracketCount === 0) {
+                processedTokens.push(currentToken);
+                currentToken = '';
+            }
+        }
+        if (bracketCount !== 0) {
+            throw new Error(`Unmatched brackets in policy line: ${line}`);
+        }
+        return processedTokens.length > 0 ? [processedTokens] : null;
+    }
+}
+export class PolicyLoader {
+    constructor(parser = new BracketAwareCsvParser()) {
+        this.parser = parser;
+    }
+    loadPolicyLine(line, model) {
+        const tokens = this.parser.parse(line);
         if (!tokens || !tokens[0]) {
             return;
         }
-        const key = tokens[0][0];
+        let key = tokens[0][0].trim();
+        if (key.startsWith('"') && key.endsWith('"')) {
+            key = key.slice(1, -1);
+        }
         const sec = key.substring(0, 1);
         const item = model.model.get(sec);
         if (!item) {
@@ -22,6 +66,18 @@ export class Helper {
         if (!policy) {
             return;
         }
-        policy.policy.push(tokens[0].slice(1));
+        const values = tokens[0].slice(1).map((v) => {
+            if (v.startsWith('"') && v.endsWith('"')) {
+                v = v.slice(1, -1);
+            }
+            return v.replace(/""/g, '"').trim();
+        });
+        policy.policy.push(values);
+    }
+}
+export class Helper {
+    static loadPolicyLine(line, model) {
+        Helper.policyLoader.loadPolicyLine(line, model);
     }
 }
+Helper.policyLoader = new PolicyLoader();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "casbin",
-  "version": "5.35.0",
+  "version": "5.37.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",
@@ -52,7 +52,7 @@
     "@casbin/expression-eval": "^5.3.0",
     "await-lock": "^2.0.1",
     "buffer": "^6.0.3",
-    "csv-parse": "^5.3.5",
+    "csv-parse": "^5.5.6",
     "minimatch": "^7.4.2"
   },
   "files": [