@yroshcha/node-red-contrib-redis-full 1.0.8 → 2.0.1

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project are documented in this file.
 
+## 2.0.1 — 2026-09-07
+
+### Added
+
+- Added importable examples for every public palette node: Redis basics, Streams consumption, and Streams operations. This satisfies the Flow Library scorecard rule that every non-config node appears in an example flow.
+
+## 2.0.0 — 2026-09-07
+
+### Breaking changes
+
+- The minimum supported Node.js version is now 20 and the minimum supported Node-RED version is now 4. This aligns the package with `ioredis` 6.
+
+### Changed
+
+- Updated `ioredis` to the current 6.x release line.
+- Added an importable Redis Streams example flow (`XADD → XREADGROUP → XACK`) for the Node-RED library.
+
+## 1.0.9 — 2026-09-07
+
+### Fixed
+
+- Declared the supported Node-RED runtime range in the package metadata so the Flow Library scorecard and Palette Manager can evaluate compatibility correctly.
+
 ## 1.0.8 — 2026-08-12
 
 ### Fixed

package/README.md

@@ -45,7 +45,7 @@ For a local archive, use `npm install /path/to/yroshcha-node-red-contrib-redis-f
 
 ## Release status
 
-**`1.0.8` is the current stable release.** See [CHANGELOG.md](CHANGELOG.md) for release notes and compatibility information.
+**`2.0.1` is the current stable release.** See [CHANGELOG.md](CHANGELOG.md) for release notes and compatibility information.
 
 ## Production profile
 
@@ -124,6 +124,8 @@ Run `redis consumer gc` from an input message, typically a scheduled Inject node
 
 ## Example flow
 
+After installing the palette, open **Import → Examples**. The package provides short, self-contained flows for Redis basics, Redis Streams consumption, and Redis Streams operations. They use a local Redis configuration and `example:*` keys so you can inspect and adapt them safely.
+
 ```
 [yroshcha-redis-config] ← shared configuration for all nodes below
 

package/examples/redis-basics.json

@@ -0,0 +1,169 @@
+[
+  {
+    "id": "redis-basics-example-tab",
+    "type": "tab",
+    "label": "Redis basics",
+    "disabled": false,
+    "info": "Short, independent examples for commands, transactions, scanning, and Pub/Sub. Set the config node to a Redis server before deploying."
+  },
+  {
+    "id": "redis-basics-example-note",
+    "type": "comment",
+    "z": "redis-basics-example-tab",
+    "name": "Redis basics: command, MULTI/EXEC, SCAN, and Pub/Sub",
+    "info": "Each branch is independent. Click its Inject node after configuring Redis. The subscription starts when the flow is deployed and writes received messages to Debug.",
+    "x": 340,
+    "y": 60,
+    "wires": []
+  },
+  {
+    "id": "redis-basics-example-config",
+    "type": "yroshcha-redis-config",
+    "name": "Local Redis",
+    "host": "127.0.0.1",
+    "port": "6379",
+    "db": "0",
+    "username": "",
+    "tls": false,
+    "cluster": false,
+    "connectTimeout": "10000",
+    "commandTimeout": "30000",
+    "retryMaxDelay": "30000"
+  },
+  {
+    "id": "redis-basics-ping-inject",
+    "type": "inject",
+    "z": "redis-basics-example-tab",
+    "name": "Run PING",
+    "props": [{ "p": "payload" }],
+    "payload": "",
+    "payloadType": "date",
+    "x": 130,
+    "y": 140,
+    "wires": [["redis-basics-ping"]]
+  },
+  {
+    "id": "redis-basics-ping",
+    "type": "yroshcha-redis-command",
+    "z": "redis-basics-example-tab",
+    "name": "PING",
+    "server": "redis-basics-example-config",
+    "command": "PING",
+    "allowMsgCommand": false,
+    "block": false,
+    "x": 320,
+    "y": 140,
+    "wires": [["redis-basics-ping-debug"]]
+  },
+  {
+    "id": "redis-basics-ping-debug",
+    "type": "debug",
+    "z": "redis-basics-example-tab",
+    "name": "PING result",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 500,
+    "y": 140,
+    "wires": []
+  },
+  {
+    "id": "redis-basics-multi-inject",
+    "type": "inject",
+    "z": "redis-basics-example-tab",
+    "name": "Run transaction",
+    "props": [{ "p": "commands", "v": "[[\"set\",\"example:counter\",\"0\"],[\"incr\",\"example:counter\"]]", "vt": "json" }],
+    "x": 140,
+    "y": 200,
+    "wires": [["redis-basics-multi"]]
+  },
+  {
+    "id": "redis-basics-multi",
+    "type": "yroshcha-redis-multi",
+    "z": "redis-basics-example-tab",
+    "name": "MULTI / EXEC",
+    "server": "redis-basics-example-config",
+    "x": 330,
+    "y": 200,
+    "wires": [["redis-basics-multi-debug"]]
+  },
+  {
+    "id": "redis-basics-multi-debug",
+    "type": "debug",
+    "z": "redis-basics-example-tab",
+    "name": "Transaction result",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 520,
+    "y": 200,
+    "wires": []
+  },
+  {
+    "id": "redis-basics-scan-inject",
+    "type": "inject",
+    "z": "redis-basics-example-tab",
+    "name": "Scan keys",
+    "props": [{ "p": "payload" }],
+    "payload": "",
+    "payloadType": "date",
+    "x": 130,
+    "y": 260,
+    "wires": [["redis-basics-scan"]]
+  },
+  {
+    "id": "redis-basics-scan",
+    "type": "yroshcha-redis-scan",
+    "z": "redis-basics-example-tab",
+    "name": "SCAN up to 100 keys",
+    "server": "redis-basics-example-config",
+    "scanType": "SCAN",
+    "count": "100",
+    "maxResults": "100",
+    "x": 345,
+    "y": 260,
+    "wires": [["redis-basics-scan-debug"]]
+  },
+  {
+    "id": "redis-basics-scan-debug",
+    "type": "debug",
+    "z": "redis-basics-example-tab",
+    "name": "Keys",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 510,
+    "y": 260,
+    "wires": []
+  },
+  {
+    "id": "redis-basics-subscribe",
+    "type": "yroshcha-redis-subscribe",
+    "z": "redis-basics-example-tab",
+    "name": "Subscribe example:notifications",
+    "server": "redis-basics-example-config",
+    "mode": "subscribe",
+    "channels": "example:notifications",
+    "topic": "",
+    "timeout": "0",
+    "x": 240,
+    "y": 340,
+    "wires": [["redis-basics-subscribe-debug"]]
+  },
+  {
+    "id": "redis-basics-subscribe-debug",
+    "type": "debug",
+    "z": "redis-basics-example-tab",
+    "name": "Received notification",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "targetType": "full",
+    "x": 515,
+    "y": 340,
+    "wires": []
+  }
+]

package/examples/redis-stream-operations.json

@@ -0,0 +1,216 @@
+[
+  {
+    "id": "redis-stream-ops-example-tab",
+    "type": "tab",
+    "label": "Redis Streams operations",
+    "disabled": false,
+    "info": "On-demand operational flows for a Redis Streams consumer group. Configure the stream and group names before using any Inject node."
+  },
+  {
+    "id": "redis-stream-ops-example-note",
+    "type": "comment",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Redis Streams operations: metrics, recovery, consumer cleanup, and control",
+    "info": "Set the Redis config and example:events/example-workers values to match an existing stream and consumer group. These nodes run only when their Inject node is clicked. The HTTP API remains disabled until explicitly enabled in its edit dialog.",
+    "x": 390,
+    "y": 60,
+    "wires": []
+  },
+  {
+    "id": "redis-stream-ops-example-config",
+    "type": "yroshcha-redis-config",
+    "name": "Local Redis",
+    "host": "127.0.0.1",
+    "port": "6379",
+    "db": "0",
+    "username": "",
+    "tls": false,
+    "cluster": false,
+    "connectTimeout": "10000",
+    "commandTimeout": "30000",
+    "retryMaxDelay": "30000"
+  },
+  {
+    "id": "redis-stream-ops-metrics-inject",
+    "type": "inject",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Collect metrics",
+    "props": [{ "p": "payload" }],
+    "payload": "",
+    "payloadType": "date",
+    "x": 125,
+    "y": 140,
+    "wires": [["redis-stream-ops-metrics"]]
+  },
+  {
+    "id": "redis-stream-ops-metrics",
+    "type": "yroshcha-redis-stream-metrics",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Metrics for example-workers",
+    "server": "redis-stream-ops-example-config",
+    "streamKey": "example:events",
+    "group": "example-workers",
+    "deadLetterStream": "",
+    "x": 350,
+    "y": 140,
+    "wires": [["redis-stream-ops-metrics-debug"]]
+  },
+  {
+    "id": "redis-stream-ops-metrics-debug",
+    "type": "debug",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Metrics",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 560,
+    "y": 140,
+    "wires": []
+  },
+  {
+    "id": "redis-stream-ops-claim-inject",
+    "type": "inject",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Recover idle pending entries",
+    "props": [{ "p": "payload" }],
+    "payload": "",
+    "payloadType": "date",
+    "x": 165,
+    "y": 200,
+    "wires": [["redis-stream-ops-claim"]]
+  },
+  {
+    "id": "redis-stream-ops-claim",
+    "type": "yroshcha-redis-stream-claim",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Claim entries idle for 60s",
+    "server": "redis-stream-ops-example-config",
+    "streamKey": "example:events",
+    "group": "example-workers",
+    "consumer": "recovery-worker",
+    "minIdleMs": "60000",
+    "count": "100",
+    "maxMessages": "1000",
+    "x": 410,
+    "y": 200,
+    "wires": [["redis-stream-ops-claim-debug"]]
+  },
+  {
+    "id": "redis-stream-ops-claim-debug",
+    "type": "debug",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Claimed entries",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 625,
+    "y": 200,
+    "wires": []
+  },
+  {
+    "id": "redis-stream-ops-gc-inject",
+    "type": "inject",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Remove idle consumers",
+    "props": [{ "p": "payload" }],
+    "payload": "",
+    "payloadType": "date",
+    "x": 145,
+    "y": 260,
+    "wires": [["redis-stream-ops-gc"]]
+  },
+  {
+    "id": "redis-stream-ops-gc",
+    "type": "yroshcha-redis-stream-gc",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Clean consumers idle for 10 min",
+    "server": "redis-stream-ops-example-config",
+    "streamKey": "example:events",
+    "group": "example-workers",
+    "minIdleMs": "600000",
+    "x": 405,
+    "y": 260,
+    "wires": [["redis-stream-ops-gc-debug"]]
+  },
+  {
+    "id": "redis-stream-ops-gc-debug",
+    "type": "debug",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Cleanup result",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 625,
+    "y": 260,
+    "wires": []
+  },
+  {
+    "id": "redis-stream-ops-pause-inject",
+    "type": "inject",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Pause local consumers",
+    "props": [{ "p": "action", "v": "pause", "vt": "str" }],
+    "x": 145,
+    "y": 340,
+    "wires": [["redis-stream-ops-control"]]
+  },
+  {
+    "id": "redis-stream-ops-resume-inject",
+    "type": "inject",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Resume local consumers",
+    "props": [{ "p": "action", "v": "resume", "vt": "str" }],
+    "x": 145,
+    "y": 390,
+    "wires": [["redis-stream-ops-control"]]
+  },
+  {
+    "id": "redis-stream-ops-control",
+    "type": "yroshcha-redis-stream-control",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Control local xreadgroup nodes",
+    "x": 405,
+    "y": 365,
+    "wires": [["redis-stream-ops-control-debug"]]
+  },
+  {
+    "id": "redis-stream-ops-control-debug",
+    "type": "debug",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Control result",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 645,
+    "y": 365,
+    "wires": []
+  },
+  {
+    "id": "redis-stream-ops-api",
+    "type": "yroshcha-redis-stream-api",
+    "z": "redis-stream-ops-example-tab",
+    "name": "Optional Streams HTTP API (disabled)",
+    "enabled": false,
+    "requireToken": false,
+    "x": 265,
+    "y": 460,
+    "wires": [["redis-stream-ops-api-debug"]]
+  },
+  {
+    "id": "redis-stream-ops-api-debug",
+    "type": "debug",
+    "z": "redis-stream-ops-example-tab",
+    "name": "HTTP API result",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 540,
+    "y": 460,
+    "wires": []
+  }
+]

package/examples/redis-streams.json

@@ -0,0 +1,163 @@
+[
+  {
+    "id": "redis-streams-example-tab",
+    "type": "tab",
+    "label": "Redis Streams example",
+    "disabled": false,
+    "info": "Publish an example event, consume it with a Redis consumer group, then ACK it after processing."
+  },
+  {
+    "id": "redis-streams-example-note",
+    "type": "comment",
+    "z": "redis-streams-example-tab",
+    "name": "Redis Streams: XADD → XREADGROUP → XACK",
+    "info": "Set the Redis config node to your Redis server. Click Publish example event. The consumer group is created automatically and the event is acknowledged after the processing function completes.",
+    "x": 310,
+    "y": 60,
+    "wires": []
+  },
+  {
+    "id": "redis-streams-example-config",
+    "type": "yroshcha-redis-config",
+    "name": "Local Redis",
+    "host": "127.0.0.1",
+    "port": "6379",
+    "db": "0",
+    "username": "",
+    "tls": false,
+    "cluster": false,
+    "connectTimeout": "10000",
+    "commandTimeout": "30000",
+    "retryMaxDelay": "30000"
+  },
+  {
+    "id": "redis-streams-example-inject",
+    "type": "inject",
+    "z": "redis-streams-example-tab",
+    "name": "Publish example event",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"eventType\":\"example.created\",\"event\":{\"id\":\"example-1\",\"message\":\"Hello Redis Streams\"}}",
+    "payloadType": "json",
+    "x": 160,
+    "y": 140,
+    "wires": [["redis-streams-example-out"]]
+  },
+  {
+    "id": "redis-streams-example-out",
+    "type": "yroshcha-redis-stream-out",
+    "z": "redis-streams-example-tab",
+    "name": "XADD example:events",
+    "server": "redis-streams-example-config",
+    "streamKey": "example:events",
+    "maxlen": "",
+    "approxTrim": true,
+    "unsafeTrim": false,
+    "x": 400,
+    "y": 140,
+    "wires": [["redis-streams-example-published"]]
+  },
+  {
+    "id": "redis-streams-example-published",
+    "type": "debug",
+    "z": "redis-streams-example-tab",
+    "name": "Published stream ID",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "streamId",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 650,
+    "y": 140,
+    "wires": []
+  },
+  {
+    "id": "redis-streams-example-in",
+    "type": "yroshcha-redis-stream-in",
+    "z": "redis-streams-example-tab",
+    "name": "XREADGROUP example-workers",
+    "server": "redis-streams-example-config",
+    "streamKey": "example:events",
+    "group": "example-workers",
+    "consumer": "",
+    "count": "100",
+    "blockMs": "5000",
+    "readIntervalMs": "0",
+    "rateLimitPerSecond": "0",
+    "batchWindowMs": "0",
+    "batchIntervalMs": "0",
+    "autoAck": false,
+    "startPaused": false,
+    "startId": "$",
+    "maxPending": "1000",
+    "capacityPollMs": "500",
+    "capacityCheckIntervalMs": "250",
+    "autoClaim": true,
+    "reclaimIdleMs": "60000",
+    "reclaimIntervalMs": "30000",
+    "reclaimCount": "100",
+    "maxDeliveries": "5",
+    "deadLetterStream": "",
+    "initialBackoffMs": "500",
+    "maxBackoffMs": "30000",
+    "backoffMultiplier": "2",
+    "pelAlertThreshold": "0",
+    "pelCheckIntervalMs": "30000",
+    "x": 190,
+    "y": 260,
+    "wires": [["redis-streams-example-process"]]
+  },
+  {
+    "id": "redis-streams-example-process",
+    "type": "function",
+    "z": "redis-streams-example-tab",
+    "name": "Business logic (replace me)",
+    "func": "// Do business work here.\n// ACK only after this succeeds.\nreturn msg;",
+    "outputs": 1,
+    "timeout": 0,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 445,
+    "y": 260,
+    "wires": [["redis-streams-example-ack"]]
+  },
+  {
+    "id": "redis-streams-example-ack",
+    "type": "yroshcha-redis-stream-ack",
+    "z": "redis-streams-example-tab",
+    "name": "ACK after success",
+    "server": "redis-streams-example-config",
+    "streamKey": "",
+    "group": "",
+    "deleteAfterAck": false,
+    "x": 665,
+    "y": 260,
+    "wires": [["redis-streams-example-acked"]]
+  },
+  {
+    "id": "redis-streams-example-acked",
+    "type": "debug",
+    "z": "redis-streams-example-tab",
+    "name": "ACK result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "acked",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 865,
+    "y": 260,
+    "wires": []
+  }
+]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yroshcha/node-red-contrib-redis-full",
-  "version": "1.0.8",
+  "version": "2.0.1",
   "description": "Production-oriented Redis palette for Node-RED: generic commands, Pub/Sub, scans, transactions, and Redis Streams consumer groups.",
   "keywords": ["node-red", "redis", "redis-streams", "pubsub", "xadd", "xreadgroup", "ioredis"],
   "license": "MIT",
@@ -14,12 +14,12 @@
   },
   "homepage": "https://github.com/yroshcha/node-red-contrib-redis-full#readme",
   "main": "redis.js",
-  "files": ["redis.js", "redis.html", "README.md", "CHANGELOG.md", "LICENSE", "icons"],
+  "files": ["redis.js", "redis.html", "README.md", "CHANGELOG.md", "LICENSE", "icons", "examples"],
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "peerDependencies": {
-    "node-red": ">=3 <6"
+    "node-red": ">=4 <6"
   },
   "scripts": {
     "test": "node --test test/*.test.js",
@@ -28,9 +28,10 @@
     "prepublishOnly": "npm run check"
   },
   "dependencies": {
-    "ioredis": "^5.4.1"
+    "ioredis": "^6.0.0"
   },
   "node-red": {
+    "version": ">=4.0.0 <6.0.0",
     "nodes": {
       "yroshcha-redis": "redis.js"
     }