casbin 5.45.2 → 5.46.0

package/README.md

@@ -116,26 +116,9 @@ https://casbin.org/docs/role-managers
 This project exists thanks to all the people who contribute.
 <a href="https://github.com/casbin/node-casbin/graphs/contributors"><img src="https://opencollective.com/node-casbin/contributors.svg?width=890&button=false" /></a>
 
-## Backers
+## Star History
 
-Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/casbin#backer)]
-
-<a href="https://opencollective.com/casbin#backers" target="_blank"><img src="https://opencollective.com/casbin/backers.svg?width=890"></a>
-
-## Sponsors
-
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/casbin#sponsor)]
-
-<a href="https://opencollective.com/casbin/sponsor/0/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/0/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/1/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/1/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/2/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/2/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/3/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/3/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/4/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/4/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/5/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/5/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/6/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/6/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/7/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/7/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/8/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/8/avatar.svg"></a>
-<a href="https://opencollective.com/casbin/sponsor/9/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/9/avatar.svg"></a>
+[![Star History Chart](https://api.star-history.com/svg?repos=casbin/node-casbin&type=Date)](https://star-history.com/#casbin/node-casbin&Date)
 
 ## License
 
@@ -144,7 +127,5 @@ This project is licensed under the [Apache 2.0 license](LICENSE).
 ## Contact
 
 If you have any issues or feature requests, please contact us. PR is welcomed.
-
 - https://github.com/casbin/node-casbin/issues
-- hsluoyz@gmail.com
-- Tencent QQ group: [546057381](//shang.qq.com/wpa/qunwpa?idkey=8ac8b91fc97ace3d383d0035f7aa06f7d670fd8e8d4837347354a31c18fac885)
+- https://discord.gg/S5UjpzGZjN

package/lib/cjs/internalEnforcer.d.ts

@@ -8,6 +8,12 @@ export declare class InternalEnforcer extends CoreEnforcer {
      */
     protected addPolicyInternal(sec: string, ptype: string, rule: string[], useWatcher: boolean): Promise<boolean>;
     protected addPoliciesInternal(sec: string, ptype: string, rules: string[][], useWatcher: boolean): Promise<boolean>;
+    /**
+     * addPoliciesInternalEx adds rules to the current policy.
+     * Unlike addPoliciesInternal, this method will filter out rules that already exist
+     * and continue to add the remaining rules instead of returning false immediately.
+     */
+    protected addPoliciesInternalEx(sec: string, ptype: string, rules: string[][], useWatcher: boolean): Promise<boolean>;
     /**
      * updatePolicyInternal updates a rule from the current policy.
      */

package/lib/cjs/internalEnforcer.js

@@ -94,6 +94,50 @@ class InternalEnforcer extends coreEnforcer_1.CoreEnforcer {
         }
         return ok;
     }
+    /**
+     * addPoliciesInternalEx adds rules to the current policy.
+     * Unlike addPoliciesInternal, this method will filter out rules that already exist
+     * and continue to add the remaining rules instead of returning false immediately.
+     */
+    async addPoliciesInternalEx(sec, ptype, rules, useWatcher) {
+        // Filter out existing rules
+        const newRules = rules.filter((rule) => !this.model.hasPolicy(sec, ptype, rule));
+        // If no new rules to add, return false
+        if (newRules.length === 0) {
+            return false;
+        }
+        if (this.autoSave) {
+            if ('addPolicies' in this.adapter) {
+                try {
+                    await this.adapter.addPolicies(sec, ptype, newRules);
+                }
+                catch (e) {
+                    if (e.message !== 'not implemented') {
+                        throw e;
+                    }
+                }
+            }
+            else {
+                throw new Error('cannot save policy, the adapter does not implement the BatchAdapter');
+            }
+        }
+        if (useWatcher) {
+            if (this.autoNotifyWatcher) {
+                // error intentionally ignored
+                if (this.watcherEx) {
+                    this.watcherEx.updateForAddPolicies(sec, ptype, ...newRules);
+                }
+                else if (this.watcher) {
+                    this.watcher.update();
+                }
+            }
+        }
+        const [ok, effects] = await this.model.addPolicies(sec, ptype, newRules);
+        if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {
+            await this.buildIncrementalRoleLinks(model_1.PolicyOp.PolicyAdd, ptype, effects);
+        }
+        return ok;
+    }
     /**
      * updatePolicyInternal updates a rule from the current policy.
      */

package/lib/cjs/managementEnforcer.d.ts

@@ -195,6 +195,25 @@ export declare class ManagementEnforcer extends InternalEnforcer {
      * @return succeeds or not.
      */
     addNamedPolicies(ptype: string, rules: string[][]): Promise<boolean>;
+    /**
+     * addPoliciesEx adds authorization rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "p" policy rules, ptype "p" is implicitly used.
+     * @return succeeds or not.
+     */
+    addPoliciesEx(rules: string[][]): Promise<boolean>;
+    /**
+     * addNamedPoliciesEx adds authorization rules to the current named policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "p", "p2", "p3", ..
+     * @param rules the "p" policy rules.
+     * @return succeeds or not.
+     */
+    addNamedPoliciesEx(ptype: string, rules: string[][]): Promise<boolean>;
     /**
      * updatePolicy updates an authorization rule from the current policy.
      * If the rule not exists, the function returns false.
@@ -318,6 +337,25 @@ export declare class ManagementEnforcer extends InternalEnforcer {
      * @return succeeds or not.
      */
     addNamedGroupingPolicies(ptype: string, rules: string[][]): Promise<boolean>;
+    /**
+     * addGroupingPoliciesEx adds role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "g" policy rules, ptype "g" is implicitly used.
+     * @return succeeds or not.
+     */
+    addGroupingPoliciesEx(rules: string[][]): Promise<boolean>;
+    /**
+     * addNamedGroupingPoliciesEx adds named role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "g", "g2", "g3", ..
+     * @param rules the "g" policy rules.
+     * @return succeeds or not.
+     */
+    addNamedGroupingPoliciesEx(ptype: string, rules: string[][]): Promise<boolean>;
     /**
      * removeGroupingPolicy removes a role inheritance rule from the current policy.
      *

package/lib/cjs/managementEnforcer.js

@@ -254,6 +254,29 @@ class ManagementEnforcer extends internalEnforcer_1.InternalEnforcer {
     async addNamedPolicies(ptype, rules) {
         return this.addPoliciesInternal('p', ptype, rules, true);
     }
+    /**
+     * addPoliciesEx adds authorization rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "p" policy rules, ptype "p" is implicitly used.
+     * @return succeeds or not.
+     */
+    async addPoliciesEx(rules) {
+        return this.addNamedPoliciesEx('p', rules);
+    }
+    /**
+     * addNamedPoliciesEx adds authorization rules to the current named policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "p", "p2", "p3", ..
+     * @param rules the "p" policy rules.
+     * @return succeeds or not.
+     */
+    async addNamedPoliciesEx(ptype, rules) {
+        return this.addPoliciesInternalEx('p', ptype, rules, true);
+    }
     /**
      * updatePolicy updates an authorization rule from the current policy.
      * If the rule not exists, the function returns false.
@@ -405,6 +428,29 @@ class ManagementEnforcer extends internalEnforcer_1.InternalEnforcer {
     async addNamedGroupingPolicies(ptype, rules) {
         return this.addPoliciesInternal('g', ptype, rules, true);
     }
+    /**
+     * addGroupingPoliciesEx adds role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "g" policy rules, ptype "g" is implicitly used.
+     * @return succeeds or not.
+     */
+    async addGroupingPoliciesEx(rules) {
+        return this.addNamedGroupingPoliciesEx('g', rules);
+    }
+    /**
+     * addNamedGroupingPoliciesEx adds named role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "g", "g2", "g3", ..
+     * @param rules the "g" policy rules.
+     * @return succeeds or not.
+     */
+    async addNamedGroupingPoliciesEx(ptype, rules) {
+        return this.addPoliciesInternalEx('g', ptype, rules, true);
+    }
     /**
      * removeGroupingPolicy removes a role inheritance rule from the current policy.
      *

package/lib/esm/internalEnforcer.d.ts

@@ -8,6 +8,12 @@ export declare class InternalEnforcer extends CoreEnforcer {
      */
     protected addPolicyInternal(sec: string, ptype: string, rule: string[], useWatcher: boolean): Promise<boolean>;
     protected addPoliciesInternal(sec: string, ptype: string, rules: string[][], useWatcher: boolean): Promise<boolean>;
+    /**
+     * addPoliciesInternalEx adds rules to the current policy.
+     * Unlike addPoliciesInternal, this method will filter out rules that already exist
+     * and continue to add the remaining rules instead of returning false immediately.
+     */
+    protected addPoliciesInternalEx(sec: string, ptype: string, rules: string[][], useWatcher: boolean): Promise<boolean>;
     /**
      * updatePolicyInternal updates a rule from the current policy.
      */

package/lib/esm/internalEnforcer.js

@@ -91,6 +91,50 @@ export class InternalEnforcer extends CoreEnforcer {
         }
         return ok;
     }
+    /**
+     * addPoliciesInternalEx adds rules to the current policy.
+     * Unlike addPoliciesInternal, this method will filter out rules that already exist
+     * and continue to add the remaining rules instead of returning false immediately.
+     */
+    async addPoliciesInternalEx(sec, ptype, rules, useWatcher) {
+        // Filter out existing rules
+        const newRules = rules.filter((rule) => !this.model.hasPolicy(sec, ptype, rule));
+        // If no new rules to add, return false
+        if (newRules.length === 0) {
+            return false;
+        }
+        if (this.autoSave) {
+            if ('addPolicies' in this.adapter) {
+                try {
+                    await this.adapter.addPolicies(sec, ptype, newRules);
+                }
+                catch (e) {
+                    if (e.message !== 'not implemented') {
+                        throw e;
+                    }
+                }
+            }
+            else {
+                throw new Error('cannot save policy, the adapter does not implement the BatchAdapter');
+            }
+        }
+        if (useWatcher) {
+            if (this.autoNotifyWatcher) {
+                // error intentionally ignored
+                if (this.watcherEx) {
+                    this.watcherEx.updateForAddPolicies(sec, ptype, ...newRules);
+                }
+                else if (this.watcher) {
+                    this.watcher.update();
+                }
+            }
+        }
+        const [ok, effects] = await this.model.addPolicies(sec, ptype, newRules);
+        if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {
+            await this.buildIncrementalRoleLinks(PolicyOp.PolicyAdd, ptype, effects);
+        }
+        return ok;
+    }
     /**
      * updatePolicyInternal updates a rule from the current policy.
      */

package/lib/esm/managementEnforcer.d.ts

@@ -195,6 +195,25 @@ export declare class ManagementEnforcer extends InternalEnforcer {
      * @return succeeds or not.
      */
     addNamedPolicies(ptype: string, rules: string[][]): Promise<boolean>;
+    /**
+     * addPoliciesEx adds authorization rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "p" policy rules, ptype "p" is implicitly used.
+     * @return succeeds or not.
+     */
+    addPoliciesEx(rules: string[][]): Promise<boolean>;
+    /**
+     * addNamedPoliciesEx adds authorization rules to the current named policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "p", "p2", "p3", ..
+     * @param rules the "p" policy rules.
+     * @return succeeds or not.
+     */
+    addNamedPoliciesEx(ptype: string, rules: string[][]): Promise<boolean>;
     /**
      * updatePolicy updates an authorization rule from the current policy.
      * If the rule not exists, the function returns false.
@@ -318,6 +337,25 @@ export declare class ManagementEnforcer extends InternalEnforcer {
      * @return succeeds or not.
      */
     addNamedGroupingPolicies(ptype: string, rules: string[][]): Promise<boolean>;
+    /**
+     * addGroupingPoliciesEx adds role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "g" policy rules, ptype "g" is implicitly used.
+     * @return succeeds or not.
+     */
+    addGroupingPoliciesEx(rules: string[][]): Promise<boolean>;
+    /**
+     * addNamedGroupingPoliciesEx adds named role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "g", "g2", "g3", ..
+     * @param rules the "g" policy rules.
+     * @return succeeds or not.
+     */
+    addNamedGroupingPoliciesEx(ptype: string, rules: string[][]): Promise<boolean>;
     /**
      * removeGroupingPolicy removes a role inheritance rule from the current policy.
      *

package/lib/esm/managementEnforcer.js

@@ -251,6 +251,29 @@ export class ManagementEnforcer extends InternalEnforcer {
     async addNamedPolicies(ptype, rules) {
         return this.addPoliciesInternal('p', ptype, rules, true);
     }
+    /**
+     * addPoliciesEx adds authorization rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "p" policy rules, ptype "p" is implicitly used.
+     * @return succeeds or not.
+     */
+    async addPoliciesEx(rules) {
+        return this.addNamedPoliciesEx('p', rules);
+    }
+    /**
+     * addNamedPoliciesEx adds authorization rules to the current named policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "p", "p2", "p3", ..
+     * @param rules the "p" policy rules.
+     * @return succeeds or not.
+     */
+    async addNamedPoliciesEx(ptype, rules) {
+        return this.addPoliciesInternalEx('p', ptype, rules, true);
+    }
     /**
      * updatePolicy updates an authorization rule from the current policy.
      * If the rule not exists, the function returns false.
@@ -402,6 +425,29 @@ export class ManagementEnforcer extends InternalEnforcer {
     async addNamedGroupingPolicies(ptype, rules) {
         return this.addPoliciesInternal('g', ptype, rules, true);
     }
+    /**
+     * addGroupingPoliciesEx adds role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param rules the "g" policy rules, ptype "g" is implicitly used.
+     * @return succeeds or not.
+     */
+    async addGroupingPoliciesEx(rules) {
+        return this.addNamedGroupingPoliciesEx('g', rules);
+    }
+    /**
+     * addNamedGroupingPoliciesEx adds named role inheritance rules to the current policy.
+     * If a rule already exists, the function will skip it and continue to add the remaining rules.
+     * The function returns true if at least one rule was added successfully.
+     *
+     * @param ptype the policy type, can be "g", "g2", "g3", ..
+     * @param rules the "g" policy rules.
+     * @return succeeds or not.
+     */
+    async addNamedGroupingPoliciesEx(ptype, rules) {
+        return this.addPoliciesInternalEx('g', ptype, rules, true);
+    }
     /**
      * removeGroupingPolicy removes a role inheritance rule from the current policy.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "casbin",
-  "version": "5.45.2",
+  "version": "5.46.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",