redis-smq-web-server 9.0.0-next.4 → 9.0.0-next.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +17 -10
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [9.0.0-next.6](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.5...v9.0.0-next.6) (2025-10-13)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package redis-smq-web-server
|
|
9
|
+
|
|
10
|
+
## [9.0.0-next.5](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.4...v9.0.0-next.5) (2025-10-12)
|
|
11
|
+
|
|
12
|
+
### 🚀 Chore
|
|
13
|
+
|
|
14
|
+
- **redis-smq-web-server:** update dependencies to latest versions ([34676ff](https://github.com/weyoss/redis-smq/commit/34676ff071c0d1f99b8b3d8efa8b1980b3e2eee6))
|
|
15
|
+
|
|
16
|
+
### 📝 Documentation
|
|
17
|
+
|
|
18
|
+
- add GitHub note callouts in README files ([86e855a](https://github.com/weyoss/redis-smq/commit/86e855ae7aea91e3295301671b8da3249164ea40))
|
|
19
|
+
- standardize "next" branch reference ([15f3e4f](https://github.com/weyoss/redis-smq/commit/15f3e4f4347fd4f76f9dc167dd72f174f178ab8e))
|
|
20
|
+
- update README files for next branch with pre-release badges and doc links ([463250b](https://github.com/weyoss/redis-smq/commit/463250bbd754d44ae6741abcf4e2d62995aef620))
|
|
21
|
+
|
|
6
22
|
## [9.0.0-next.4](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.3...v9.0.0-next.4) (2025-10-09)
|
|
7
23
|
|
|
8
24
|
### ♻️ Code Refactoring
|
package/README.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# RedisSMQ Web Server
|
|
2
2
|
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
> You are viewing the documentation for the "next" branch. These docs describe unreleased changes published under the npm "next" dist-tag.
|
|
5
|
+
> For the latest stable documentation, see:
|
|
6
|
+
>
|
|
7
|
+
> - Master (stable) README: https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server
|
|
8
|
+
> - Latest release notes/tags: https://github.com/weyoss/redis-smq/releases/latest
|
|
9
|
+
> - Install stable packages with @latest; pre-release with @next.
|
|
10
|
+
|
|
3
11
|
A lightweight, configurable HTTP server that hosts the RedisSMQ Web UI and exposes the RedisSMQ HTTP API in the same process — or proxies it to an external API service.
|
|
4
12
|
|
|
5
13
|
- Serves the SPA (Single Page Application) for monitoring and managing RedisSMQ.
|
|
@@ -19,7 +27,7 @@ A lightweight, configurable HTTP server that hosts the RedisSMQ Web UI and expos
|
|
|
19
27
|
|
|
20
28
|
```bash
|
|
21
29
|
# Using npm
|
|
22
|
-
npm install redis-smq redis-smq-common redis-smq-rest-api redis-smq-web-ui redis-smq-web-server --save
|
|
30
|
+
npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next redis-smq-web-ui@next redis-smq-web-server@next --save
|
|
23
31
|
```
|
|
24
32
|
|
|
25
33
|
Don't forget to install a Redis client. Choose either node-redis or ioredis:
|
|
@@ -69,7 +77,7 @@ npx redis-smq-web-server \
|
|
|
69
77
|
--api-proxy-target http://127.0.0.1:7210
|
|
70
78
|
```
|
|
71
79
|
|
|
72
|
-
When `--api-proxy-target` is provided, requests to `<basePath>/api`, `<basePath>/docs`, and `<basePath>/assets` are forwarded
|
|
80
|
+
When `--api-proxy-target` is provided, requests to `<basePath>/api`, `<basePath>/docs`, and `<basePath>/assets` are forwarded
|
|
73
81
|
to the upstream. In this mode, Redis connection options on the web server are not used; the upstream API service manages Redis.
|
|
74
82
|
|
|
75
83
|
### Programmatically (optional)
|
|
@@ -125,8 +133,8 @@ await srv.run();
|
|
|
125
133
|
- UI: served from the configured base path
|
|
126
134
|
- Example: basePath = / → UI at /
|
|
127
135
|
- Example: basePath = /redis-smq → UI at /redis-smq
|
|
128
|
-
|
|
129
136
|
- HTTP API: mounted under <basePath>/api
|
|
137
|
+
|
|
130
138
|
- Example: basePath = / → API at /api
|
|
131
139
|
- Example: basePath = /redis-smq → API at /redis-smq/api
|
|
132
140
|
|
|
@@ -175,12 +183,12 @@ interface IRedisSMQWebServerConfig extends IRedisSMQRestApiConfig {
|
|
|
175
183
|
|
|
176
184
|
Notes:
|
|
177
185
|
|
|
178
|
-
- When `webServer.apiProxyTarget` is set, the server proxies `<basePath>/api`, `<basePath>/docs`, and
|
|
179
|
-
`<basePath>/assets` to the target. In this mode, redis and logger options are not used by the web server (they are
|
|
180
|
-
handled by the upstream API service).
|
|
186
|
+
- When `webServer.apiProxyTarget` is set, the server proxies `<basePath>/api`, `<basePath>/docs`, and
|
|
187
|
+
`<basePath>/assets` to the target. In this mode, redis and logger options are not used by the web server (they are
|
|
188
|
+
handled by the upstream API service).
|
|
181
189
|
|
|
182
|
-
- When `webServer.apiProxyTarget` is not set, the web server mounts the embedded `redis-smq-rest-api` using the provided
|
|
183
|
-
`IRedisSMQRestApiConfig` (redis, logger, etc.).
|
|
190
|
+
- When `webServer.apiProxyTarget` is not set, the web server mounts the embedded `redis-smq-rest-api` using the provided
|
|
191
|
+
`IRedisSMQRestApiConfig` (redis, logger, etc.).
|
|
184
192
|
|
|
185
193
|
### ClI flags
|
|
186
194
|
|
|
@@ -209,5 +217,4 @@ handled by the upstream API service).
|
|
|
209
217
|
|
|
210
218
|
## License
|
|
211
219
|
|
|
212
|
-
RedisSMQ Web Server is licensed under is released under the [MIT License](
|
|
213
|
-
|
|
220
|
+
RedisSMQ Web Server is licensed under is released under the [MIT License](/LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "redis-smq-web-server",
|
|
3
|
-
"version": "9.0.0-next.
|
|
3
|
+
"version": "9.0.0-next.6",
|
|
4
4
|
"description": "Web server for RedisSMQ Web UI: serves the SPA and hosts or proxies the RedisSMQ REST API.",
|
|
5
5
|
"author": "Weyoss <weyoss@protonmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"redis-smq-web-server": "./dist/esm/bin/cli.js"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"commander": "
|
|
38
|
+
"commander": "14.0.1",
|
|
39
39
|
"express": "4.21.2",
|
|
40
40
|
"http-proxy-middleware": "3.0.5"
|
|
41
41
|
},
|
|
@@ -43,12 +43,12 @@
|
|
|
43
43
|
"@types/express": "4.17.23"
|
|
44
44
|
},
|
|
45
45
|
"peerDependencies": {
|
|
46
|
-
"@redis/client": "^
|
|
47
|
-
"ioredis": "^5
|
|
48
|
-
"redis-smq": "^9.0.0-next.
|
|
49
|
-
"redis-smq-common": "^9.0.0-next.
|
|
50
|
-
"redis-smq-rest-api": "^9.0.0-next.
|
|
51
|
-
"redis-smq-web-ui": "^9.0.0-next.
|
|
46
|
+
"@redis/client": "^5",
|
|
47
|
+
"ioredis": "^5",
|
|
48
|
+
"redis-smq": "^9.0.0-next.6",
|
|
49
|
+
"redis-smq-common": "^9.0.0-next.6",
|
|
50
|
+
"redis-smq-rest-api": "^9.0.0-next.6",
|
|
51
|
+
"redis-smq-web-ui": "^9.0.0-next.6"
|
|
52
52
|
},
|
|
53
53
|
"peerDependenciesMeta": {
|
|
54
54
|
"@redis/client": {
|