redis-smq-rest-api 9.0.8 → 9.0.9-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.
- package/CHANGELOG.md +10 -0
- package/README.md +13 -13
- package/dist/cjs/bin/cli.d.ts +3 -0
- package/dist/cjs/bin/cli.d.ts.map +1 -0
- package/dist/cjs/bin/cli.js +51 -0
- package/dist/cjs/bin/cli.js.map +1 -0
- package/dist/esm/bin/cli.d.ts +3 -0
- package/dist/esm/bin/cli.d.ts.map +1 -0
- package/dist/esm/bin/cli.js.map +1 -0
- package/package.json +3 -3
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.9-next.0](https://github.com/weyoss/redis-smq/compare/v9.0.8...v9.0.9-next.0) (2026-01-08)
|
|
7
|
+
|
|
8
|
+
### 🐛 Bug Fixes
|
|
9
|
+
|
|
10
|
+
- **redis-smq-rest-api:** include 'bin' directory in npm package ([88e27ca](https://github.com/weyoss/redis-smq/commit/88e27ca83b4c2670a41735c5795bff767f201c89))
|
|
11
|
+
|
|
12
|
+
### 🚀 Chore
|
|
13
|
+
|
|
14
|
+
- update READMEs after merging 'v9.0.8' into 'next' ([9ea29cc](https://github.com/weyoss/redis-smq/commit/9ea29cc2af7906285c5ccc675c65167d2e8005d6))
|
|
15
|
+
|
|
6
16
|
## [9.0.8](https://github.com/weyoss/redis-smq/compare/v9.0.8-next.0...v9.0.8) (2026-01-04)
|
|
7
17
|
|
|
8
18
|
### 🚀 Chore
|
package/README.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# RedisSMQ REST API
|
|
2
2
|
|
|
3
3
|
> [!NOTE]
|
|
4
|
-
> You are viewing the documentation for the "
|
|
5
|
-
> For
|
|
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
6
|
>
|
|
7
|
-
> -
|
|
7
|
+
> - Master (stable) README: https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-rest-api
|
|
8
8
|
> - Latest release notes/tags: https://github.com/weyoss/redis-smq/releases/latest
|
|
9
9
|
> - Install stable packages with @latest; pre-release with @next.
|
|
10
10
|
|
|
11
|
-
[](https://github.com/weyoss/redis-smq/releases)
|
|
12
|
+
[](https://app.codecov.io/github/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api)
|
|
13
13
|
|
|
14
14
|
RedisSMQ REST API provides an HTTP interface enabling any web-capable application to interact with the RedisSMQ message
|
|
15
15
|
queue using a RESTful API.
|
|
@@ -26,7 +26,7 @@ queue using a RESTful API.
|
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
28
|
# Using npm
|
|
29
|
-
npm install redis-smq redis-smq-common redis-smq-rest-api --save
|
|
29
|
+
npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next --save
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
Don't forget to install a Redis client. Choose either node-redis or ioredis:
|
|
@@ -39,19 +39,19 @@ npm install ioredis --save
|
|
|
39
39
|
|
|
40
40
|
## Version Compatibility
|
|
41
41
|
|
|
42
|
-
Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](https://github.com/weyoss/redis-smq/tree/
|
|
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.
|
|
43
43
|
|
|
44
44
|
## Documentation
|
|
45
45
|
|
|
46
|
-
For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/
|
|
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):
|
|
47
47
|
|
|
48
48
|
## Related packages
|
|
49
49
|
|
|
50
|
-
- [redis-smq](https://github.com/weyoss/redis-smq/tree/
|
|
51
|
-
- [redis-smq-common](https://github.com/weyoss/redis-smq/tree/
|
|
52
|
-
- [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/
|
|
53
|
-
- [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/
|
|
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
|
|
54
54
|
|
|
55
55
|
## License
|
|
56
56
|
|
|
57
|
-
RedisSMQ REST API is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/
|
|
57
|
+
RedisSMQ REST API is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/next/LICENSE).
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../bin/cli.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
"use strict";
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
const commander_1 = require("commander");
|
|
5
|
+
const index_js_1 = require("../src/index.js");
|
|
6
|
+
const redis_smq_common_1 = require("redis-smq-common");
|
|
7
|
+
const index_js_2 = require("../src/config/index.js");
|
|
8
|
+
const redis_smq_1 = require("redis-smq");
|
|
9
|
+
const defaultLogLevel = typeof redis_smq_1.defaultConfig.logger.options.logLevel === 'number'
|
|
10
|
+
? redis_smq_1.defaultConfig.logger.options.logLevel
|
|
11
|
+
: redis_smq_common_1.EConsoleLoggerLevel[redis_smq_1.defaultConfig.logger.options.logLevel];
|
|
12
|
+
const program = new commander_1.Command();
|
|
13
|
+
program.name('redis-smq-rest-api').description('RedisSMQ REST API server');
|
|
14
|
+
program
|
|
15
|
+
.option('-p, --port <number>', 'Port to run the REST API on', String(index_js_2.DEFAULT_PORT))
|
|
16
|
+
.option('-b, --base-path <string>', 'Base path to mount the REST API under', index_js_2.DEFAULT_BASE_PATH)
|
|
17
|
+
.option('-c, --redis-client <ioredis|redis>', 'Redis client. Valid options are: ioredis, redis.', redis_smq_1.defaultConfig.redis.client)
|
|
18
|
+
.option('-r, --redis-host <string>', 'Redis server host', redis_smq_1.defaultConfig.redis.options.host)
|
|
19
|
+
.option('-o, --redis-port <number>', 'Redis server port', String(redis_smq_1.defaultConfig.redis.options.port))
|
|
20
|
+
.option('-d, --redis-db <number>', 'Redis database number', String(redis_smq_1.defaultConfig.redis.options.db))
|
|
21
|
+
.option('-e, --enable-log <0|1>', 'Enable console logging: 0 (disabled), 1 (enabled)', String(Number(redis_smq_1.defaultConfig.logger.enabled)))
|
|
22
|
+
.option('-v, --log-level <0|1|2|3>', `Log level. Numbers: ${redis_smq_common_1.EConsoleLoggerLevel.DEBUG}=DEBUG, ${redis_smq_common_1.EConsoleLoggerLevel.INFO}=INFO, ${redis_smq_common_1.EConsoleLoggerLevel.WARN}=WARN, ${redis_smq_common_1.EConsoleLoggerLevel.ERROR}=ERROR`, String(defaultLogLevel))
|
|
23
|
+
.helpOption('-h, --help', 'Display help for command');
|
|
24
|
+
program.parse();
|
|
25
|
+
const options = program.opts();
|
|
26
|
+
const config = {
|
|
27
|
+
apiServer: {
|
|
28
|
+
port: Number(options.port),
|
|
29
|
+
basePath: options.basePath,
|
|
30
|
+
},
|
|
31
|
+
redis: {
|
|
32
|
+
client: options.redisClient,
|
|
33
|
+
options: {
|
|
34
|
+
host: options.redisHost,
|
|
35
|
+
port: Number(options.redisPort),
|
|
36
|
+
db: Number(options.redisDb),
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
logger: {
|
|
40
|
+
enabled: Boolean(Number(options.enableLog)),
|
|
41
|
+
options: {
|
|
42
|
+
logLevel: Number(options.logLevel),
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
const api = new index_js_1.RedisSMQRestApi(config);
|
|
47
|
+
api.run().catch((err) => {
|
|
48
|
+
console.error(err);
|
|
49
|
+
process.exit(1);
|
|
50
|
+
});
|
|
51
|
+
//# sourceMappingURL=cli.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../bin/cli.ts"],"names":[],"mappings":";;;AAWA,yCAAoC;AACpC,8CAAkD;AAClD,uDAAuD;AACvD,qDAKgC;AAChC,yCAAmE;AAGnE,MAAM,eAAe,GACnB,OAAO,yBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ;IAC/D,CAAC,CAAC,yBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ;IAC/C,CAAC,CAAC,sCAAmB,CAAC,yBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEzE,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC;AAE3E,OAAO;KAEJ,MAAM,CACL,qBAAqB,EACrB,6BAA6B,EAC7B,MAAM,CAAC,uBAAY,CAAC,CACrB;KACA,MAAM,CACL,0BAA0B,EAC1B,uCAAuC,EACvC,4BAAiB,CAClB;KAGA,MAAM,CACL,oCAAoC,EACpC,kDAAkD,EAClD,yBAAqB,CAAC,KAAK,CAAC,MAAM,CACnC;KACA,MAAM,CACL,2BAA2B,EAC3B,mBAAmB,EACnB,yBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CACzC;KACA,MAAM,CAEL,2BAA2B,EAC3B,mBAAmB,EACnB,MAAM,CAAC,yBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CACjD;KACA,MAAM,CACL,yBAAyB,EACzB,uBAAuB,EACvB,MAAM,CAAC,yBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAC/C;KAGA,MAAM,CACL,wBAAwB,EACxB,mDAAmD,EACnD,MAAM,CAAC,MAAM,CAAC,yBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CACrD;KACA,MAAM,CACL,2BAA2B,EAC3B,uBAAuB,sCAAmB,CAAC,KAAK,WAAW,sCAAmB,CAAC,IAAI,UAAU,sCAAmB,CAAC,IAAI,UAAU,sCAAmB,CAAC,KAAK,QAAQ,EAChK,MAAM,CAAC,eAAe,CAAC,CACxB;KAGA,UAAU,CAAC,YAAY,EAAE,0BAA0B,CAAC,CAAC;AAExD,OAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAA+B,OAAO,CAAC,IAAI,EAAE,CAAC;AAG3D,MAAM,MAAM,GAA2B;IACrC,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B;IACD,KAAK,EAAE;QACL,MAAM,EAAE,OAAO,CAAC,WAAW;QAC3B,OAAO,EAAE;YACP,IAAI,EAAE,OAAO,CAAC,SAAS;YACvB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;YAC/B,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC5B;KACF;IACD,MAAM,EAAE;QACN,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3C,OAAO,EAAE;YACP,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;SACnC;KACF;CACF,CAAC;AAEF,MAAM,GAAG,GAAG,IAAI,0BAAe,CAAC,MAAM,CAAC,CAAC;AACxC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IAC/B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../bin/cli.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../bin/cli.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EACL,iBAAiB,EACjB,YAAY,GAGb,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,IAAI,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAGnE,MAAM,eAAe,GACnB,OAAO,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ;IAC/D,CAAC,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ;IAC/C,CAAC,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEzE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC;AAE3E,OAAO;KAEJ,MAAM,CACL,qBAAqB,EACrB,6BAA6B,EAC7B,MAAM,CAAC,YAAY,CAAC,CACrB;KACA,MAAM,CACL,0BAA0B,EAC1B,uCAAuC,EACvC,iBAAiB,CAClB;KAGA,MAAM,CACL,oCAAoC,EACpC,kDAAkD,EAClD,qBAAqB,CAAC,KAAK,CAAC,MAAM,CACnC;KACA,MAAM,CACL,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CACzC;KACA,MAAM,CAEL,2BAA2B,EAC3B,mBAAmB,EACnB,MAAM,CAAC,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CACjD;KACA,MAAM,CACL,yBAAyB,EACzB,uBAAuB,EACvB,MAAM,CAAC,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAC/C;KAGA,MAAM,CACL,wBAAwB,EACxB,mDAAmD,EACnD,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CACrD;KACA,MAAM,CACL,2BAA2B,EAC3B,uBAAuB,mBAAmB,CAAC,KAAK,WAAW,mBAAmB,CAAC,IAAI,UAAU,mBAAmB,CAAC,IAAI,UAAU,mBAAmB,CAAC,KAAK,QAAQ,EAChK,MAAM,CAAC,eAAe,CAAC,CACxB;KAGA,UAAU,CAAC,YAAY,EAAE,0BAA0B,CAAC,CAAC;AAExD,OAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAA+B,OAAO,CAAC,IAAI,EAAE,CAAC;AAG3D,MAAM,MAAM,GAA2B;IACrC,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B;IACD,KAAK,EAAE;QACL,MAAM,EAAE,OAAO,CAAC,WAAW;QAC3B,OAAO,EAAE;YACP,IAAI,EAAE,OAAO,CAAC,SAAS;YACvB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;YAC/B,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC5B;KACF;IACD,MAAM,EAAE;QACN,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3C,OAAO,EAAE;YACP,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;SACnC;KACF;CACF,CAAC;AAEF,MAAM,GAAG,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACxC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IAC/B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "redis-smq-rest-api",
|
|
3
|
-
"version": "9.0.
|
|
3
|
+
"version": "9.0.9-next.0",
|
|
4
4
|
"description": "REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.",
|
|
5
5
|
"author": "Weyoss <weyoss@outlook.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -68,8 +68,8 @@
|
|
|
68
68
|
"peerDependencies": {
|
|
69
69
|
"@redis/client": "^5",
|
|
70
70
|
"ioredis": "^5",
|
|
71
|
-
"redis-smq": "^9.0.
|
|
72
|
-
"redis-smq-common": "^9.0.
|
|
71
|
+
"redis-smq": "^9.0.9-next.0",
|
|
72
|
+
"redis-smq-common": "^9.0.9-next.0"
|
|
73
73
|
},
|
|
74
74
|
"peerDependenciesMeta": {
|
|
75
75
|
"@redis/client": {
|