redis-smq-common 9.0.1 → 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 +10 -0
  2. package/README.md +19 -11
  3. package/README.template.md +67 -0
  4. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -3,6 +3,16 @@
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
+
6
16
  ## [9.0.1](https://github.com/weyoss/redis-smq/compare/v9.0.0...v9.0.1) (2025-11-07)
7
17
 
8
18
  ### 📝 Documentation
package/README.md CHANGED
@@ -1,7 +1,15 @@
1
1
  # RedisSMQ Common Library
2
2
 
3
- [![Release (latest)](https://img.shields.io/npm/v/redis-smq-common/latest?style=flat-square&label=redis-smq-common%40latest)](https://www.npmjs.com/package/redis-smq-common?activeTab=versions)
4
- [![Code Coverage (latest)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-common&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-common)
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-common
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-common/next?style=flat-square&label=redis-smq-common%40next)](https://www.npmjs.com/package/redis-smq-common?activeTab=versions)
12
+ [![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-common&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-common)
5
13
 
6
14
  A shared foundation for the RedisSMQ ecosystem.
7
15
  This package provides essential components and utilities used by RedisSMQ and related packages, helping you configure
@@ -24,9 +32,9 @@ Redis clients, structure logging, and reuse core types across the stack.
24
32
  Install the package:
25
33
 
26
34
  ```bash
27
- npm install redis-smq-common@latest
35
+ npm install redis-smq-common@next
28
36
  # or
29
- pnpm add redis-smq-common@latest
37
+ pnpm add redis-smq-common@next
30
38
  ```
31
39
 
32
40
  This package works with multiple Redis clients. Install one of the supported clients based on your needs:
@@ -47,19 +55,19 @@ Note: Redis clients are optional peer dependencies; pick one and configure it in
47
55
 
48
56
  ## Version compatibility
49
57
 
50
- 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.
58
+ 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.
51
59
 
52
60
  ## Documentation
53
61
 
54
- For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/docs/README.md).
62
+ For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common/docs/README.md).
55
63
 
56
64
  ## Related packages
57
65
 
58
- - [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue for Node.js
59
- - [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
60
- - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/README.md): Web server for hosting the UI and proxying/serving the API
61
- - [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
66
+ - [redis-smq](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/README.md): Core message queue for Node.js
67
+ - [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
68
+ - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server/README.md): Web server for hosting the UI and proxying/serving the API
69
+ - [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
62
70
 
63
71
  ## License
64
72
 
65
- RedisSMQ Common Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
73
+ RedisSMQ Common Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).
package/README.template.md ADDED
@@ -0,0 +1,67 @@
1
+ # RedisSMQ Common Library
2
+
3
+ __IS_NEXT_NOTE__
4
+
5
+ __NPM_BADGE__
6
+ __CODECOV_BADGE__
7
+
8
+ A shared foundation for the RedisSMQ ecosystem.
9
+ This package provides essential components and utilities used by RedisSMQ and related packages, helping you configure
10
+ Redis clients, structure logging, and reuse core types across the stack.
11
+
12
+ - Used by: `redis-smq`, `redis-smq-rest-api`, `redis-smq-web-server`, and `redis-smq-web-ui`
13
+ - Node.js 20+ is required
14
+
15
+ ## Features
16
+
17
+ - Core types and utilities shared across RedisSMQ packages
18
+ - Configuration helpers and enums (e.g., select Redis client implementation)
19
+ - Logging interfaces and a Console logger implementation
20
+ - Redis client abstractions and guidance for supported clients
21
+ - File-based synchronization primitives (e.g., FileLock)
22
+ - Thorough documentation for server/client setup and usage
23
+
24
+ ## Installation
25
+
26
+ Install the package:
27
+
28
+ ```bash
29
+ npm install redis-smq-common__TAG_SUFFIX__
30
+ # or
31
+ pnpm add redis-smq-common__TAG_SUFFIX__
32
+ ```
33
+
34
+ This package works with multiple Redis clients. Install one of the supported clients based on your needs:
35
+
36
+ - ioredis (recommended for advanced features)
37
+
38
+ ```shell
39
+ npm install ioredis
40
+ ```
41
+
42
+ - @redis/client (official Redis client)
43
+
44
+ ```shell
45
+ npm install @redis/client
46
+ ```
47
+
48
+ Note: Redis clients are optional peer dependencies; pick one and configure it in your application.
49
+
50
+ ## Version compatibility
51
+
52
+ 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.
53
+
54
+ ## Documentation
55
+
56
+ For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-common/docs/README.md).
57
+
58
+ ## Related packages
59
+
60
+ - [redis-smq](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq/README.md): Core message queue for Node.js
61
+ - [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
62
+ - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-web-server/README.md): Web server for hosting the UI and proxying/serving the API
63
+ - [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
64
+
65
+ ## License
66
+
67
+ RedisSMQ Common Library 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-common",
3
- "version": "9.0.1",
3
+ "version": "9.0.2-next.0",
4
4
  "description": "Provides essential components and utilities shared across RedisSMQ packages.",
5
5
  "author": "Weyoss <weyoss@protonmail.com>",
6
6
  "license": "MIT",
@@ -81,7 +81,7 @@
81
81
  "node": ">=20"
82
82
  },
83
83
  "scripts": {
84
- "test": "../../scripts/test_workspace_esm.sh",
84
+ "test": "../../scripts/test-workspace-esm.sh",
85
85
  "build": "scripts/build.sh",
86
86
  "document": "scripts/document.sh"
87
87
  }