@casbin/redis-watcher 1.0.1 → 1.2.0

package/README.md

@@ -1,47 +1,88 @@
-# Redis-watcher
+# Redis Watcher
 
-Redis watcher for node-casbin based on [ioredis](https://github.com/luin/ioredis).
+[![CI](https://github.com/node-casbin/redis-watcher/actions/workflows/ci.yml/badge.svg)](https://github.com/node-casbin/redis-watcher/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/node-casbin/redis-watcher/badge.svg?branch=master)](https://coveralls.io/github/node-casbin/redis-watcher?branch=master)
+[![NPM version][npm-image]][npm-url]
+[![NPM download][download-image]][download-url]
+[![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2)](https://discord.gg/S5UjpzGZjN)
 
-# Installation
+[npm-image]: https://img.shields.io/npm/v/@casbin/redis-watcher.svg?style=flat-square
+[npm-url]: https://npmjs.com/package/@casbin/redis-watcher
+[download-image]: https://img.shields.io/npm/dm/@casbin/redis-watcher.svg?style=flat-square
+[download-url]: https://npmjs.com/package/@casbin/redis-watcher
 
-```shell script
-# NPM
-npm install --save @casbin/redis-watcher
+Redis Watcher is the [Redis](https://redis.io/) watcher for [Node-Casbin](https://github.com/casbin/node-casbin). With this library, Node-Casbin can synchronize policy changes across multiple enforcer instances via Redis pub/sub.
 
-# Yarn
-yarn add @casbin/redis-watcher
+This watcher is based on [ioredis](https://github.com/luin/ioredis) and supports both single Redis instances and Redis clusters.
+
+## Installation
+
+```bash
+npm install @casbin/redis-watcher
 ```
 
-**Note: redis-watcher has been deprecated on NPM.**
+**Note: The old package name `redis-watcher` has been deprecated on NPM. Please use `@casbin/redis-watcher` instead.**
+
+## Simple Example
 
-# Example
 Using Redis:
 
 ```typescript
 import { RedisWatcher } from '@casbin/redis-watcher';
 import { newEnforcer } from 'casbin';
 
-// Initialize the watcher, see https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
-const watcher = await RedisWatcher.newWatcher('redis://localhost:6379/5');
+async function myFunction() {
+    // Initialize the watcher
+    // See https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+    const watcher = await RedisWatcher.newWatcher('redis://localhost:6379/5');
+
+    // Initialize the enforcer
+    const enforcer = await newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv');
 
-// Initialize the enforcer.
-const enforcer = await newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv');
+    // Set the watcher for the enforcer
+    enforcer.setWatcher(watcher);
 
-enforcer.setWatcher(watcher);
+    // Update the policy
+    await enforcer.addPolicy('alice', 'data1', 'read');
+    
+    // The policy change will be synchronized to other enforcers via Redis pub/sub
+}
 ```
 
-Using Redis cluster:
+Using Redis Cluster:
 
 ```typescript
 import { RedisWatcher } from '@casbin/redis-watcher';
 import { newEnforcer } from 'casbin';
 
-// Initialize the watcher, see https://github.com/luin/ioredis/blob/master/API.md#new-clusterstartupnodes-options.
-const watcher = await RedisWatcher.newWatcherWithCluster([{ port: 7000, host: 'localhost' }]);
+async function myFunction() {
+    // Initialize the watcher with Redis cluster
+    // See https://github.com/luin/ioredis/blob/master/API.md#new-clusterstartupnodes-options
+    const watcher = await RedisWatcher.newWatcherWithCluster([
+        { port: 7000, host: 'localhost' },
+        { port: 7001, host: 'localhost' },
+        { port: 7002, host: 'localhost' }
+    ]);
+
+    // Initialize the enforcer
+    const enforcer = await newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv');
+
+    // Set the watcher for the enforcer
+    enforcer.setWatcher(watcher);
+
+    // Update the policy
+    await enforcer.addPolicy('bob', 'data2', 'write');
+    
+    // The policy change will be synchronized to other enforcers via Redis pub/sub
+}
+```
 
-// Initialize the enforcer.
-const enforcer = await newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv');
+## Getting Help
 
-enforcer.setWatcher(watcher);
-```
+- [Node-Casbin](https://github.com/casbin/node-casbin)
+- [Casbin Forum](https://forum.casbin.com/)
+
+## License
+
+This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casbin/redis-watcher",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Redis watcher for node-casbin",
   "main": "lib/watcher.js",
   "typings": "lib/watcher.d.ts",
@@ -10,7 +10,9 @@
     "prettier": "prettier --write **/*.{ts,js}",
     "build": "rimraf lib && tsc -p tsconfig.json",
     "lint": "tslint -p . -c tslint.json",
-    "test": "jest --forceExit"
+    "test": "jest --forceExit",
+    "coverage": "jest --coverage --forceExit",
+    "release": "npx -p semantic-release -p @semantic-release/git -p @semantic-release/changelog semantic-release"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^5.0.1",
@@ -19,10 +21,12 @@
     "@semantic-release/github": "^7.2.0",
     "@semantic-release/npm": "^7.0.8",
     "@semantic-release/release-notes-generator": "^9.0.1",
+    "@types/babel__core": "7.1.7",
+    "@types/babel__traverse": "7.0.8",
     "@types/ioredis": "^4.14.3",
     "@types/jest": "^24.0.11",
     "@types/node": "^10.5.3",
-    "casbin": "^5.2.1",
+    "casbin": "5.2.1",
     "coveralls": "^3.0.2",
     "jest": "^24.9.0",
     "lint-staged": "^8.1.7",
@@ -36,6 +40,9 @@
   "dependencies": {
     "ioredis": "^4.11.1"
   },
+  "resolutions": {
+    "@types/babel__traverse": "7.0.8"
+  },
   "files": [
     "lib",
     "examples"