redis-smq-web-server 9.0.0 → 9.0.2-next.0

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +18 -10
  3. package/README.template.md +52 -0
  4. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -3,6 +3,23 @@
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.2-next.0](https://github.com/weyoss/redis-smq/compare/v9.0.1...v9.0.2-next.0) (2025-11-08)
7
+
8
+ ### ✅ Tests
9
+
10
+ - rename test_workspace_esm.sh to test-workspace-esm.sh ([4c56821](https://github.com/weyoss/redis-smq/commit/4c5682125c99949118141418c11bd296d2869172))
11
+
12
+ ### 📦‍ Build System
13
+
14
+ - automate README.md files update ([9d54181](https://github.com/weyoss/redis-smq/commit/9d54181260e6615d176fe47b4786f8edb21c2911))
15
+
16
+ ## [9.0.1](https://github.com/weyoss/redis-smq/compare/v9.0.0...v9.0.1) (2025-11-07)
17
+
18
+ ### 📝 Documentation
19
+
20
+ - update install commands to use [@latest](https://github.com/latest) instead of [@next](https://github.com/next) ([353abe8](https://github.com/weyoss/redis-smq/commit/353abe893f457f706290c7c182a2b8bc07458dbe))
21
+ - update README files for release v9 ([b838b11](https://github.com/weyoss/redis-smq/commit/b838b119323e9c73a420bef1d07a0d432f3607f0))
22
+
6
23
  ## [9.0.0](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.18...v9.0.0) (2025-11-07)
7
24
 
8
25
  **Note:** Version bump only for package redis-smq-web-server
package/README.md CHANGED
@@ -1,7 +1,15 @@
1
1
  # RedisSMQ Web Server
2
2
 
3
- [![Release (latest)](https://img.shields.io/npm/v/redis-smq-web-server/latest?style=flat-square&label=redis-smq-web-server%40latest)](https://www.npmjs.com/package/redis-smq-web-server?activeTab=versions)
4
- [![Code Coverage (latest)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-web-server&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-web-server)
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
+
11
+ [![Pre-release (next)](https://img.shields.io/npm/v/redis-smq-web-server/next?style=flat-square&label=redis-smq-web-server%40next)](https://www.npmjs.com/package/redis-smq-web-server?activeTab=versions)
12
+ [![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-web-server&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-web-server)
5
13
 
6
14
  A lightweight server that brings the RedisSMQ management ecosystem to life. It serves the official Web UI and provides
7
15
  the REST API through two flexible modes of operation:
@@ -19,7 +27,7 @@ the REST API through two flexible modes of operation:
19
27
 
20
28
  ```bash
21
29
  # Using npm
22
- npm install redis-smq@latest redis-smq-common@latest redis-smq-rest-api@latest redis-smq-web-ui@latest redis-smq-web-server@latest --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:
@@ -32,19 +40,19 @@ npm install ioredis --save
32
40
 
33
41
  ## Version Compatibility
34
42
 
35
- Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/docs/version-compatibility.md) for details.
43
+ Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/docs/version-compatibility.md) for details.
36
44
 
37
45
  ## Documentation
38
46
 
39
- For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/docs/README.md).
47
+ For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server/docs/README.md).
40
48
 
41
49
  ## Related packages
42
50
 
43
- - [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue
44
- - [redis-smq-common](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/README.md): Shared components/utilities
45
- - [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
46
- - [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
51
+ - [redis-smq](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/README.md): Core message queue
52
+ - [redis-smq-common](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common/README.md): Shared components/utilities
53
+ - [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
54
+ - [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
47
55
 
48
56
  ## License
49
57
 
50
- RedisSMQ Web Server is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
58
+ RedisSMQ Web Server is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).
package/README.template.md ADDED
@@ -0,0 +1,52 @@
1
+ # RedisSMQ Web Server
2
+
3
+ __IS_NEXT_NOTE__
4
+
5
+ __NPM_BADGE__
6
+ __CODECOV_BADGE__
7
+
8
+ A lightweight server that brings the RedisSMQ management ecosystem to life. It serves the official Web UI and provides
9
+ the REST API through two flexible modes of operation:
10
+
11
+ - **Standalone Mode:** Run the Web UI and REST API in a single process for an all-in-one setup.
12
+ - **Proxy Mode:** Serve the Web UI and proxy API requests to a separate redis-smq-rest-api instance for distributed deployments.
13
+
14
+ ## Features
15
+
16
+ - **Dual-Mode Operation:** Standalone (UI + API in one process) or Proxy (UI + proxied API).
17
+ - **Versatile Execution:** Start from the CLI as a standalone server or embed as a library in your Node.js app.
18
+ - **Consistent Ecosystem:** Works seamlessly with `redis-smq`, `redis-smq-rest-api`, and `redis-smq-web-ui`.
19
+
20
+ ## Installation
21
+
22
+ ```bash
23
+ # Using npm
24
+ npm install redis-smq__TAG_SUFFIX__ redis-smq-common__TAG_SUFFIX__ redis-smq-rest-api__TAG_SUFFIX__ redis-smq-web-ui__TAG_SUFFIX__ redis-smq-web-server__TAG_SUFFIX__ --save
25
+ ```
26
+
27
+ Don't forget to install a Redis client. Choose either node-redis or ioredis:
28
+
29
+ ```shell
30
+ npm install @redis/client --save
31
+ # or
32
+ npm install ioredis --save
33
+ ```
34
+
35
+ ## Version Compatibility
36
+
37
+ Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq/docs/version-compatibility.md) for details.
38
+
39
+ ## Documentation
40
+
41
+ For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-web-server/docs/README.md).
42
+
43
+ ## Related packages
44
+
45
+ - [redis-smq](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq/README.md): Core message queue
46
+ - [redis-smq-common](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-common/README.md): Shared components/utilities
47
+ - [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
48
+ - [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
49
+
50
+ ## License
51
+
52
+ RedisSMQ Web Server is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "redis-smq-web-server",
3
- "version": "9.0.0",
3
+ "version": "9.0.2-next.0",
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",
@@ -46,10 +46,10 @@
46
46
  "peerDependencies": {
47
47
  "@redis/client": "^5",
48
48
  "ioredis": "^5",
49
- "redis-smq": "^9.0.0",
50
- "redis-smq-common": "^9.0.0",
51
- "redis-smq-rest-api": "^9.0.0",
52
- "redis-smq-web-ui": "^9.0.0"
49
+ "redis-smq": "^9.0.2-next.0",
50
+ "redis-smq-common": "^9.0.2-next.0",
51
+ "redis-smq-rest-api": "^9.0.2-next.0",
52
+ "redis-smq-web-ui": "^9.0.2-next.0"
53
53
  },
54
54
  "peerDependenciesMeta": {
55
55
  "@redis/client": {
@@ -66,6 +66,6 @@
66
66
  "scripts": {
67
67
  "build": "scripts/build.sh",
68
68
  "dev": "tsc -w & node --watch dist/index.js",
69
- "test": "../../scripts/test_workspace_esm.sh"
69
+ "test": "../../scripts/test-workspace-esm.sh"
70
70
  }
71
71
  }