@bymax-one/nest-realtime 1.0.5 → 1.1.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 +33 -1
- package/README.md +3 -3
- package/package.json +7 -6
package/CHANGELOG.md
CHANGED
|
@@ -5,7 +5,37 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
-
## [
|
|
8
|
+
## [1.1.0] - 2026-08-11
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- **Peer dependency `ioredis` moved to `^6.0.0`** (from `^5.0.0`). The ecosystem migrates to
|
|
13
|
+
ioredis 6 in lockstep because `@bymax-one/nest-queue` now requires it and an app installs a
|
|
14
|
+
single ioredis; ioredis 6 keeps `replyMapping: "legacy"` by default, so reply shapes are
|
|
15
|
+
unchanged and this library — which only takes an injected client — needs no runtime change.
|
|
16
|
+
`ioredis` remains an optional peer.
|
|
17
|
+
|
|
18
|
+
### Internal
|
|
19
|
+
|
|
20
|
+
- Stryker gate raised to 100: `thresholds.high`/`low`/`break` are now `100` (the score is already
|
|
21
|
+
100% with 0 survivors), tightening the mutation floor from 95.
|
|
22
|
+
|
|
23
|
+
## [1.0.6] - 2026-08-06
|
|
24
|
+
|
|
25
|
+
**Published-artifact change, not a behavioural one.** `dist/` differs from `1.0.5` — this
|
|
26
|
+
bundler preserves comments and the source gained mutation-suppression notes — but no runtime
|
|
27
|
+
path changed. Measured by building both revisions and diffing the output.
|
|
28
|
+
|
|
29
|
+
### Documentation
|
|
30
|
+
|
|
31
|
+
- The mutation badge said **99.27%**; the measured score is **100.00%**.
|
|
32
|
+
|
|
33
|
+
### Tests
|
|
34
|
+
|
|
35
|
+
- The SSE stream teardown is pinned: unsubscribing the outer stream leaves the merged subject
|
|
36
|
+
unobserved. RxJS reaches that through the subscriber linkage even without the explicit
|
|
37
|
+
`inner.unsubscribe()`, which the report records — the behaviour is worth pinning whichever way
|
|
38
|
+
it is achieved.
|
|
9
39
|
|
|
10
40
|
## [1.0.5] - 2026-08-04
|
|
11
41
|
|
|
@@ -213,6 +243,8 @@ First published release.
|
|
|
213
243
|
asked about NestJS and never put the same question to the other ten peers.
|
|
214
244
|
|
|
215
245
|
[Unreleased]: https://github.com/bymaxone/nest-realtime/compare/v1.0.5...HEAD
|
|
246
|
+
[1.1.0]: https://github.com/bymaxone/nest-realtime/compare/v1.0.6...v1.1.0
|
|
247
|
+
[1.0.6]: https://github.com/bymaxone/nest-realtime/compare/v1.0.5...v1.0.6
|
|
216
248
|
[1.0.5]: https://github.com/bymaxone/nest-realtime/compare/v1.0.4...v1.0.5
|
|
217
249
|
[1.0.4]: https://github.com/bymaxone/nest-realtime/compare/v1.0.3...v1.0.4
|
|
218
250
|
[1.0.3]: https://github.com/bymaxone/nest-realtime/compare/v1.0.2...v1.0.3
|
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<a href="https://www.npmjs.com/package/@bymax-one/nest-realtime"><img src="https://img.shields.io/npm/dm/@bymax-one/nest-realtime?style=flat-square&colorA=000000&colorB=000000" alt="npm downloads" /></a>
|
|
15
15
|
<a href="https://github.com/bymaxone/nest-realtime/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/bymaxone/nest-realtime/ci.yml?branch=main&style=flat-square&colorA=000000&label=CI" alt="CI status" /></a>
|
|
16
16
|
<a href="https://github.com/bymaxone/nest-realtime/actions/workflows/ci.yml"><img src="https://img.shields.io/badge/coverage-100%25-brightgreen?style=flat-square&colorA=000000" alt="coverage" /></a>
|
|
17
|
-
<a href="https://github.com/bymaxone/nest-realtime/blob/main/docs/mutation_testing_results.md"><img src="https://img.shields.io/badge/mutation-
|
|
17
|
+
<a href="https://github.com/bymaxone/nest-realtime/blob/main/docs/mutation_testing_results.md"><img src="https://img.shields.io/badge/mutation-100.00%25-brightgreen?style=flat-square&colorA=000000" alt="mutation score" /></a>
|
|
18
18
|
<a href="https://scorecard.dev/viewer/?uri=github.com/bymaxone/nest-realtime"><img src="https://api.scorecard.dev/projects/github.com/bymaxone/nest-realtime/badge?style=flat-square" alt="OpenSSF Scorecard" /></a>
|
|
19
19
|
<a href="https://github.com/bymaxone/nest-realtime/blob/main/LICENSE"><img src="https://img.shields.io/github/license/bymaxone/nest-realtime?style=flat-square&colorA=000000&colorB=000000" alt="license" /></a>
|
|
20
20
|
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript" /></a>
|
|
@@ -461,8 +461,8 @@ When integrating `@bymax-one/nest-realtime` in production, verify each of the fo
|
|
|
461
461
|
A realtime channel fails in ways that are hard to reproduce — dropped streams, races between reconnect and revocation, one instance not seeing another's emit. The suite is built so those failures are caught by a test, not by a user.
|
|
462
462
|
|
|
463
463
|
- ✅ **100% coverage** — statements, branches, functions, and lines, enforced as a release gate
|
|
464
|
-
- ✅ **
|
|
465
|
-
- ✅ **
|
|
464
|
+
- ✅ **100.00% mutation score** — 655 killed and 7 timed out, zero survivors, verified with [Stryker](https://stryker-mutator.io/) (break threshold 100)
|
|
465
|
+
- ✅ **626 tests** — 593 unit and integration across 37 suites, plus 33 end-to-end across 6
|
|
466
466
|
- ✅ **Cross-instance e2e** — real Redis pub/sub fan-out between two live instances, not a mocked channel
|
|
467
467
|
- ✅ **Bundle-size gate** — the SSE-only React bundle is measured on every build and fails over budget
|
|
468
468
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymax-one/nest-realtime",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Realtime backend → frontend communication for NestJS — dual-transport SSE (default) and WebSocket (opt-in) with a unified server-side API.",
|
|
5
5
|
"author": "Bymax One <support@bymax.one>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -95,6 +95,7 @@
|
|
|
95
95
|
"scripts": {
|
|
96
96
|
"build": "pnpm clean && tsup",
|
|
97
97
|
"check:exports": "attw --pack . --profile strict",
|
|
98
|
+
"check:mutants": "node scripts/check-mutation-directives.mjs",
|
|
98
99
|
"check:published": "node scripts/check-published-surface.mjs",
|
|
99
100
|
"check:runtime": "node scripts/check-consumer-runtime.mjs",
|
|
100
101
|
"check:surface": "node scripts/check-public-surface.mjs",
|
|
@@ -102,9 +103,9 @@
|
|
|
102
103
|
"lint": "eslint src",
|
|
103
104
|
"lint:fix": "eslint src --fix",
|
|
104
105
|
"mutation": "stryker run",
|
|
106
|
+
"mutation:full": "node -e \"require('node:fs').rmSync('reports/stryker-incremental.json',{force:true,recursive:true})\" && stryker run",
|
|
105
107
|
"mutation:dry-run": "stryker run --dryRunOnly",
|
|
106
|
-
"
|
|
107
|
-
"prepublishOnly": "pnpm clean && pnpm typecheck && pnpm lint && pnpm test:cov:all && pnpm build && pnpm check:published && pnpm check:surface && pnpm check:runtime",
|
|
108
|
+
"prepublishOnly": "pnpm clean && pnpm typecheck && pnpm lint && pnpm check:mutants && pnpm test:cov:all && pnpm build && pnpm check:published && pnpm check:surface && pnpm check:runtime",
|
|
108
109
|
"release": "npm publish --provenance --access public",
|
|
109
110
|
"size": "node scripts/check-size.mjs",
|
|
110
111
|
"test": "jest",
|
|
@@ -122,7 +123,7 @@
|
|
|
122
123
|
"@nestjs/platform-socket.io": "^11.0.0",
|
|
123
124
|
"@nestjs/websockets": "^11.0.0",
|
|
124
125
|
"@socket.io/redis-adapter": "^8.0.0",
|
|
125
|
-
"ioredis": "^
|
|
126
|
+
"ioredis": "^6.0.0",
|
|
126
127
|
"react": "^19.0.0",
|
|
127
128
|
"react-dom": "^19.0.0",
|
|
128
129
|
"reflect-metadata": "^0.2.0",
|
|
@@ -187,7 +188,7 @@
|
|
|
187
188
|
"eslint-plugin-react-hooks": "^7.1.1",
|
|
188
189
|
"eslint-plugin-security": "^4.0.1",
|
|
189
190
|
"eventsource": "^4.1.0",
|
|
190
|
-
"ioredis": "^
|
|
191
|
+
"ioredis": "^6.0.0",
|
|
191
192
|
"ioredis-mock": "^8.0.0",
|
|
192
193
|
"jest": "^30.0.0",
|
|
193
194
|
"jest-environment-jsdom": "^30.0.0",
|
|
@@ -206,7 +207,7 @@
|
|
|
206
207
|
"tsup": "^8.0.0",
|
|
207
208
|
"typescript": "^5.6.0"
|
|
208
209
|
},
|
|
209
|
-
"packageManager": "pnpm@11.
|
|
210
|
+
"packageManager": "pnpm@11.20.0",
|
|
210
211
|
"engines": {
|
|
211
212
|
"node": ">=24.0.0"
|
|
212
213
|
},
|