redis-smq-rest-api 9.0.1 โ†’ 9.0.2-next.1

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 +20 -0
  2. package/README.md +18 -10
  3. package/README.template.md +52 -0
  4. package/package.json +9 -9
package/CHANGELOG.md CHANGED
@@ -3,6 +3,26 @@
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.1](https://github.com/weyoss/redis-smq/compare/v9.0.2-next.0...v9.0.2-next.1) (2025-11-08)
7
+
8
+ ### ๐Ÿ› Bug Fixes
9
+
10
+ - update deps to resolve security vulnerabilities ([390d488](https://github.com/weyoss/redis-smq/commit/390d4880241c6bc3cf37e94d1b09f34197a7fa7b))
11
+
12
+ ### ๐Ÿ“ Documentation
13
+
14
+ - update npm badge links to point to GitHub releases ([1eaee9e](https://github.com/weyoss/redis-smq/commit/1eaee9e1734b4e78ac56ca9853baac1d58dd2ec9))
15
+
16
+ ## [9.0.2-next.0](https://github.com/weyoss/redis-smq/compare/v9.0.1...v9.0.2-next.0) (2025-11-08)
17
+
18
+ ### โœ… Tests
19
+
20
+ - rename test_workspace_esm.sh to test-workspace-esm.sh ([4c56821](https://github.com/weyoss/redis-smq/commit/4c5682125c99949118141418c11bd296d2869172))
21
+
22
+ ### ๐Ÿ“ฆโ€ Build System
23
+
24
+ - automate README.md files update ([9d54181](https://github.com/weyoss/redis-smq/commit/9d54181260e6615d176fe47b4786f8edb21c2911))
25
+
6
26
  ## [9.0.1](https://github.com/weyoss/redis-smq/compare/v9.0.0...v9.0.1) (2025-11-07)
7
27
 
8
28
  ### ๐Ÿ“ Documentation
package/README.md CHANGED
@@ -1,7 +1,15 @@
1
1
  # RedisSMQ REST API
2
2
 
3
- [![Release (latest)](https://img.shields.io/npm/v/redis-smq-rest-api/latest?style=flat-square&label=redis-smq-rest-api%40latest)](https://www.npmjs.com/package/redis-smq-rest-api?activeTab=versions)
4
- [![Code Coverage (latest)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/master?flag=redis-smq-rest-api&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api)
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-rest-api
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-rest-api/next?style=flat-square&label=redis-smq-rest-api%40next)](https://github.com/weyoss/redis-smq/releases)
12
+ [![Code Coverage (next)](https://img.shields.io/codecov/c/github/weyoss/redis-smq/next?flag=redis-smq-rest-api&style=flat-square)](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api)
5
13
 
6
14
  RedisSMQ REST API provides an HTTP interface enabling any web-capable application to interact with the RedisSMQ message
7
15
  queue using a RESTful API.
@@ -18,7 +26,7 @@ queue using a RESTful API.
18
26
 
19
27
  ```bash
20
28
  # Using npm
21
- npm install redis-smq@latest redis-smq-common@latest redis-smq-rest-api@latest --save
29
+ npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next --save
22
30
  ```
23
31
 
24
32
  Don't forget to install a Redis client. Choose either node-redis or ioredis:
@@ -31,19 +39,19 @@ npm install ioredis --save
31
39
 
32
40
  ## Version Compatibility
33
41
 
34
- 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.
42
+ 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.
35
43
 
36
44
  ## Documentation
37
45
 
38
- For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api/docs/README.md):
46
+ For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api/docs/README.md):
39
47
 
40
48
  ## Related packages
41
49
 
42
- - [redis-smq](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq/README.md): Core message queue
43
- - [redis-smq-common](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-common/README.md): Shared components/utilities
44
- - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-server/README.md): Static hosting + in-process or proxied API
45
- - [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
50
+ - [redis-smq](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq/README.md): Core message queue
51
+ - [redis-smq-common](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-common/README.md): Shared components/utilities
52
+ - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-web-server/README.md): Static hosting + in-process or proxied API
53
+ - [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
46
54
 
47
55
  ## License
48
56
 
49
- RedisSMQ REST API is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/master/LICENSE).
57
+ RedisSMQ REST API 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 REST API
2
+
3
+ __IS_NEXT_NOTE__
4
+
5
+ __NPM_BADGE__
6
+ __CODECOV_BADGE__
7
+
8
+ RedisSMQ REST API provides an HTTP interface enabling any web-capable application to interact with the RedisSMQ message
9
+ queue using a RESTful API.
10
+
11
+ ## Features
12
+
13
+ - ๐Ÿš€ Clean and efficient implementation
14
+ - โœ… Strict request/response validation using [JSON Schema](https://json-schema.org/)
15
+ - ๐Ÿ“š Native [OpenAPI v3](https://www.openapis.org/) support and [Swagger UI](https://swagger.io/)
16
+ - ๐Ÿงช 90%+ code coverage with extensive testing
17
+ - ๐Ÿ“ฆ Support for both ESM & CJS modules
18
+
19
+ ## Installation
20
+
21
+ ```bash
22
+ # Using npm
23
+ npm install redis-smq__TAG_SUFFIX__ redis-smq-common__TAG_SUFFIX__ redis-smq-rest-api__TAG_SUFFIX__ --save
24
+ ```
25
+
26
+ Don't forget to install a Redis client. Choose either node-redis or ioredis:
27
+
28
+ ```shell
29
+ npm install @redis/client --save
30
+ # or
31
+ npm install ioredis --save
32
+ ```
33
+
34
+ ## Version Compatibility
35
+
36
+ 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.
37
+
38
+ ## Documentation
39
+
40
+ For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-rest-api/docs/README.md):
41
+
42
+ ## Related packages
43
+
44
+ - [redis-smq](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq/README.md): Core message queue
45
+ - [redis-smq-common](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-common/README.md): Shared components/utilities
46
+ - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-web-server/README.md): Static hosting + in-process or proxied API
47
+ - [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
48
+
49
+ ## License
50
+
51
+ RedisSMQ REST API is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/LICENSE).
52
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "redis-smq-rest-api",
3
- "version": "9.0.1",
3
+ "version": "9.0.2-next.1",
4
4
  "description": "REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.",
5
5
  "author": "Weyoss <weyoss@protonmail.com>",
6
6
  "license": "MIT",
@@ -54,13 +54,13 @@
54
54
  "ajv": "8.17.1",
55
55
  "awilix": "12.0.5",
56
56
  "bluebird": "3.7.2",
57
- "commander": "14.0.1",
57
+ "commander": "14.0.2",
58
58
  "json-schema": "0.4.0",
59
59
  "koa": "3.1.1",
60
60
  "koa-mount": "4.2.0",
61
61
  "koa-static": "5.0.0",
62
62
  "lodash": "4.17.21",
63
- "swagger-ui-dist": "5.29.4",
63
+ "swagger-ui-dist": "5.30.2",
64
64
  "tmp": "0.2.5",
65
65
  "typescript-json-schema": "0.65.1",
66
66
  "uuid": "13.0.0"
@@ -68,8 +68,8 @@
68
68
  "peerDependencies": {
69
69
  "@redis/client": "^5",
70
70
  "ioredis": "^5",
71
- "redis-smq": "^9.0.1",
72
- "redis-smq-common": "^9.0.1"
71
+ "redis-smq-common": "^9.0.2-next.1",
72
+ "redis-smq": "^9.0.2-next.1"
73
73
  },
74
74
  "peerDependenciesMeta": {
75
75
  "@redis/client": {
@@ -81,11 +81,11 @@
81
81
  },
82
82
  "devDependencies": {
83
83
  "@types/json-schema": "7.0.15",
84
- "@types/koa": "3.0.0",
84
+ "@types/koa": "3.0.1",
85
85
  "@types/koa-mount": "4.0.5",
86
86
  "@types/koa-static": "4.0.4",
87
- "@types/koa__cors": "5.0.0",
88
- "@types/koa__router": "12.0.4",
87
+ "@types/koa__cors": "5.0.1",
88
+ "@types/koa__router": "12.0.5",
89
89
  "@types/swagger-ui-dist": "3.30.6",
90
90
  "@types/tmp": "0.2.6",
91
91
  "openapi-types": "12.1.3"
@@ -102,6 +102,6 @@
102
102
  "openapi:gen": "scripts/openapi-gen.js",
103
103
  "error-mappings:gen": "scripts/error-mappings-gen.sh",
104
104
  "build": "scripts/build.sh",
105
- "test": "../../scripts/test_workspace_esm.sh"
105
+ "test": "../../scripts/test-workspace-esm.sh"
106
106
  }
107
107
  }