casbin 5.16.0 → 5.17.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [5.17.0](https://github.com/casbin/node-casbin/compare/v5.16.0...v5.17.0) (2022-08-18)
+
+
+### Features
+
+* add WatcherEx ([#381](https://github.com/casbin/node-casbin/issues/381)) ([10d7086](https://github.com/casbin/node-casbin/commit/10d7086c810ff18d9a3c792a3ec1173744bceeef))
+
 # [5.16.0](https://github.com/casbin/node-casbin/compare/v5.15.2...v5.16.0) (2022-08-11)
 
 

package/lib/cjs/coreEnforcer.d.ts

@@ -1,6 +1,6 @@
 import { Effector } from './effect';
 import { FunctionMap, Model, PolicyOp } from './model';
-import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter } from './persist';
+import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter, WatcherEx } from './persist';
 import { RoleManager } from './rbac';
 import { MatchingFunc } from './rbac';
 /**
@@ -14,6 +14,7 @@ export declare class CoreEnforcer {
     private matcherMap;
     protected adapter: UpdatableAdapter | FilteredAdapter | Adapter | BatchAdapter;
     protected watcher: Watcher | null;
+    protected watcherEx: WatcherEx | null;
     protected rmMap: Map<string, RoleManager>;
     protected enabled: boolean;
     protected autoSave: boolean;
@@ -56,6 +57,12 @@ export declare class CoreEnforcer {
      * @param watcher the watcher.
      */
     setWatcher(watcher: Watcher): void;
+    /**
+     * setWatcherEx sets the current watcherEx.
+     *
+     * @param watcherEx the watcherEx.
+     */
+    setWatcherEx(watcherEx: WatcherEx): void;
     /**
      * setRoleManager sets the current role manager.
      *

package/lib/cjs/coreEnforcer.js

@@ -29,6 +29,7 @@ class CoreEnforcer {
         this.eft = new effect_1.DefaultEffector();
         this.matcherMap = new Map();
         this.watcher = null;
+        this.watcherEx = null;
         this.enabled = true;
         this.autoSave = true;
         this.autoBuildRoleLinks = true;
@@ -96,6 +97,14 @@ class CoreEnforcer {
         this.watcher = watcher;
         watcher.setUpdateCallback(async () => await this.loadPolicy());
     }
+    /**
+     * setWatcherEx sets the current watcherEx.
+     *
+     * @param watcherEx the watcherEx.
+     */
+    setWatcherEx(watcherEx) {
+        this.watcherEx = watcherEx;
+    }
     /**
      * setRoleManager sets the current role manager.
      *
@@ -215,7 +224,10 @@ class CoreEnforcer {
         if (!flag) {
             return false;
         }
-        if (this.watcher) {
+        if (this.watcherEx) {
+            return await this.watcherEx.updateForSavePolicy(this.model);
+        }
+        else if (this.watcher) {
             return await this.watcher.update();
         }
         return true;

package/lib/cjs/internalEnforcer.js

@@ -37,9 +37,12 @@ class InternalEnforcer extends coreEnforcer_1.CoreEnforcer {
                 }
             }
         }
-        if (this.watcher && this.autoNotifyWatcher) {
+        if (this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForAddPolicy(sec, ptype, ...rule);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const ok = this.model.addPolicy(sec, ptype, rule);
         if (sec === 'g' && ok) {
@@ -70,9 +73,12 @@ class InternalEnforcer extends coreEnforcer_1.CoreEnforcer {
                 throw new Error('cannot to save policy, the adapter does not implement the BatchAdapter');
             }
         }
-        if (this.watcher && this.autoNotifyWatcher) {
+        if (this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForAddPolicies(sec, ptype, ...rules);
+            else if (this.watcher)
+                this.watcher.update();
         }
         const [ok, effects] = await this.model.addPolicies(sec, ptype, rules);
         if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {
@@ -133,7 +139,10 @@ class InternalEnforcer extends coreEnforcer_1.CoreEnforcer {
         }
         if (this.watcher && this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForRemovePolicy(sec, ptype, ...rule);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const ok = await this.model.removePolicy(sec, ptype, rule);
         if (sec === 'g' && ok) {
@@ -165,7 +174,10 @@ class InternalEnforcer extends coreEnforcer_1.CoreEnforcer {
         }
         if (this.watcher && this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForRemovePolicies(sec, ptype, ...rules);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const [ok, effects] = this.model.removePolicies(sec, ptype, rules);
         if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {
@@ -189,7 +201,10 @@ class InternalEnforcer extends coreEnforcer_1.CoreEnforcer {
         }
         if (this.watcher && this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForRemoveFilteredPolicy(sec, ptype, fieldIndex, ...fieldValues);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const [ok, effects] = this.model.removeFilteredPolicy(sec, ptype, fieldIndex, ...fieldValues);
         if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {

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

@@ -3,6 +3,7 @@ export * from './fileAdapter';
 export * from './stringAdapter';
 export * from './helper';
 export * from './watcher';
+export * from './watcherEx';
 export * from './filteredAdapter';
 export * from './defaultFilteredAdapter';
 export * from './batchAdapter';

package/lib/cjs/persist/index.js

@@ -15,6 +15,7 @@ __exportStar(require("./fileAdapter"), exports);
 __exportStar(require("./stringAdapter"), exports);
 __exportStar(require("./helper"), exports);
 __exportStar(require("./watcher"), exports);
+__exportStar(require("./watcherEx"), exports);
 __exportStar(require("./filteredAdapter"), exports);
 __exportStar(require("./defaultFilteredAdapter"), exports);
 __exportStar(require("./batchAdapter"), exports);

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

@@ -0,0 +1,9 @@
+import { Model } from '../model';
+export interface WatcherEx {
+    updateForAddPolicy(sec: string, ptype: string, ...params: string[]): Promise<void>;
+    updateForRemovePolicy(sec: string, ptype: string, ...params: string[]): Promise<void>;
+    updateForRemoveFilteredPolicy(sec: string, ptype: string, fieldIndex: number, ...fieldValues: string[]): Promise<void>;
+    updateForSavePolicy(model: Model): Promise<boolean>;
+    updateForAddPolicies(sec: string, ptype: string, ...rules: string[][]): Promise<void>;
+    updateForRemovePolicies(sec: string, ptype: string, ...rules: string[][]): Promise<void>;
+}

package/lib/cjs/persist/watcherEx.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright 2022 The Casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// 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 });

package/lib/esm/coreEnforcer.d.ts

@@ -1,6 +1,6 @@
 import { Effector } from './effect';
 import { FunctionMap, Model, PolicyOp } from './model';
-import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter } from './persist';
+import { Adapter, FilteredAdapter, Watcher, BatchAdapter, UpdatableAdapter, WatcherEx } from './persist';
 import { RoleManager } from './rbac';
 import { MatchingFunc } from './rbac';
 /**
@@ -14,6 +14,7 @@ export declare class CoreEnforcer {
     private matcherMap;
     protected adapter: UpdatableAdapter | FilteredAdapter | Adapter | BatchAdapter;
     protected watcher: Watcher | null;
+    protected watcherEx: WatcherEx | null;
     protected rmMap: Map<string, RoleManager>;
     protected enabled: boolean;
     protected autoSave: boolean;
@@ -56,6 +57,12 @@ export declare class CoreEnforcer {
      * @param watcher the watcher.
      */
     setWatcher(watcher: Watcher): void;
+    /**
+     * setWatcherEx sets the current watcherEx.
+     *
+     * @param watcherEx the watcherEx.
+     */
+    setWatcherEx(watcherEx: WatcherEx): void;
     /**
      * setRoleManager sets the current role manager.
      *

package/lib/esm/coreEnforcer.js

@@ -26,6 +26,7 @@ export class CoreEnforcer {
         this.eft = new DefaultEffector();
         this.matcherMap = new Map();
         this.watcher = null;
+        this.watcherEx = null;
         this.enabled = true;
         this.autoSave = true;
         this.autoBuildRoleLinks = true;
@@ -93,6 +94,14 @@ export class CoreEnforcer {
         this.watcher = watcher;
         watcher.setUpdateCallback(async () => await this.loadPolicy());
     }
+    /**
+     * setWatcherEx sets the current watcherEx.
+     *
+     * @param watcherEx the watcherEx.
+     */
+    setWatcherEx(watcherEx) {
+        this.watcherEx = watcherEx;
+    }
     /**
      * setRoleManager sets the current role manager.
      *
@@ -212,7 +221,10 @@ export class CoreEnforcer {
         if (!flag) {
             return false;
         }
-        if (this.watcher) {
+        if (this.watcherEx) {
+            return await this.watcherEx.updateForSavePolicy(this.model);
+        }
+        else if (this.watcher) {
             return await this.watcher.update();
         }
         return true;

package/lib/esm/internalEnforcer.js

@@ -34,9 +34,12 @@ export class InternalEnforcer extends CoreEnforcer {
                 }
             }
         }
-        if (this.watcher && this.autoNotifyWatcher) {
+        if (this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForAddPolicy(sec, ptype, ...rule);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const ok = this.model.addPolicy(sec, ptype, rule);
         if (sec === 'g' && ok) {
@@ -67,9 +70,12 @@ export class InternalEnforcer extends CoreEnforcer {
                 throw new Error('cannot to save policy, the adapter does not implement the BatchAdapter');
             }
         }
-        if (this.watcher && this.autoNotifyWatcher) {
+        if (this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForAddPolicies(sec, ptype, ...rules);
+            else if (this.watcher)
+                this.watcher.update();
         }
         const [ok, effects] = await this.model.addPolicies(sec, ptype, rules);
         if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {
@@ -130,7 +136,10 @@ export class InternalEnforcer extends CoreEnforcer {
         }
         if (this.watcher && this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForRemovePolicy(sec, ptype, ...rule);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const ok = await this.model.removePolicy(sec, ptype, rule);
         if (sec === 'g' && ok) {
@@ -162,7 +171,10 @@ export class InternalEnforcer extends CoreEnforcer {
         }
         if (this.watcher && this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForRemovePolicies(sec, ptype, ...rules);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const [ok, effects] = this.model.removePolicies(sec, ptype, rules);
         if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {
@@ -186,7 +198,10 @@ export class InternalEnforcer extends CoreEnforcer {
         }
         if (this.watcher && this.autoNotifyWatcher) {
             // error intentionally ignored
-            this.watcher.update();
+            if (this.watcherEx)
+                await this.watcherEx.updateForRemoveFilteredPolicy(sec, ptype, fieldIndex, ...fieldValues);
+            else if (this.watcher)
+                await this.watcher.update();
         }
         const [ok, effects] = this.model.removeFilteredPolicy(sec, ptype, fieldIndex, ...fieldValues);
         if (sec === 'g' && ok && (effects === null || effects === void 0 ? void 0 : effects.length)) {

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

@@ -3,6 +3,7 @@ export * from './fileAdapter';
 export * from './stringAdapter';
 export * from './helper';
 export * from './watcher';
+export * from './watcherEx';
 export * from './filteredAdapter';
 export * from './defaultFilteredAdapter';
 export * from './batchAdapter';

package/lib/esm/persist/index.js

@@ -3,6 +3,7 @@ export * from './fileAdapter';
 export * from './stringAdapter';
 export * from './helper';
 export * from './watcher';
+export * from './watcherEx';
 export * from './filteredAdapter';
 export * from './defaultFilteredAdapter';
 export * from './batchAdapter';

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

@@ -0,0 +1,9 @@
+import { Model } from '../model';
+export interface WatcherEx {
+    updateForAddPolicy(sec: string, ptype: string, ...params: string[]): Promise<void>;
+    updateForRemovePolicy(sec: string, ptype: string, ...params: string[]): Promise<void>;
+    updateForRemoveFilteredPolicy(sec: string, ptype: string, fieldIndex: number, ...fieldValues: string[]): Promise<void>;
+    updateForSavePolicy(model: Model): Promise<boolean>;
+    updateForAddPolicies(sec: string, ptype: string, ...rules: string[][]): Promise<void>;
+    updateForRemovePolicies(sec: string, ptype: string, ...rules: string[][]): Promise<void>;
+}

package/lib/esm/persist/watcherEx.js

@@ -0,0 +1,13 @@
+// Copyright 2022 The Casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// 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.

package/package.json

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