@bymax-one/nest-realtime 1.0.0 → 1.0.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.
- package/CHANGELOG.md +25 -1
- package/README.md +0 -17
- package/package.json +41 -23
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [1.0.1] - 2026-08-02
|
|
11
|
+
|
|
12
|
+
### Fixed
|
|
13
|
+
|
|
14
|
+
- **The npm package page showed no documentation.** `1.0.0` reached the registry
|
|
15
|
+
with an empty `readme` field, so the page rendered nothing — even though
|
|
16
|
+
`README.md` was present in the tarball all along. Every package here published
|
|
17
|
+
under pnpm 11 has an empty `readme`; every one published under pnpm 10, which
|
|
18
|
+
delegated to the npm CLI, carries it. The same split appears in `_npmVersion`,
|
|
19
|
+
present only on the publishes the npm CLI performed. The release workflow now
|
|
20
|
+
calls `npm publish` directly, and this release is what carries the README to
|
|
21
|
+
the registry.
|
|
22
|
+
- **`keywords` were missing from the manifest**, so the package was
|
|
23
|
+
undiscoverable by search on npm. Fourteen added, covering the transports,
|
|
24
|
+
the pub/sub and presence concepts, and the React subpath.
|
|
25
|
+
|
|
26
|
+
### Removed
|
|
27
|
+
|
|
28
|
+
- **The Roadmap section of the README.** It described work that is not shipping
|
|
29
|
+
and dates the moment it is written; the issues board is where direction
|
|
30
|
+
belongs. `README.md` ships in the package, so the section was on the npm page
|
|
31
|
+
too.
|
|
32
|
+
|
|
10
33
|
## [1.0.0] - 2026-08-02
|
|
11
34
|
|
|
12
35
|
First published release.
|
|
@@ -60,5 +83,6 @@ First published release.
|
|
|
60
83
|
rather than by the manual sweep that raised the NestJS floors — that sweep
|
|
61
84
|
asked about NestJS and never put the same question to the other ten peers.
|
|
62
85
|
|
|
63
|
-
[Unreleased]: https://github.com/bymaxone/nest-realtime/compare/v1.0.
|
|
86
|
+
[Unreleased]: https://github.com/bymaxone/nest-realtime/compare/v1.0.1...HEAD
|
|
87
|
+
[1.0.1]: https://github.com/bymaxone/nest-realtime/compare/v1.0.0...v1.0.1
|
|
64
88
|
[1.0.0]: https://github.com/bymaxone/nest-realtime/releases/tag/v1.0.0
|
package/README.md
CHANGED
|
@@ -607,23 +607,6 @@ Platform-specific configuration is in [docs/proxies-cheat-sheet.md](./docs/proxi
|
|
|
607
607
|
|
|
608
608
|
---
|
|
609
609
|
|
|
610
|
-
## 🗺️ Roadmap
|
|
611
|
-
|
|
612
|
-
The items below are directional — none are shipping today. The list exists so contributors can see where the library is headed and where help is most useful. Open an issue to discuss priorities or propose a design.
|
|
613
|
-
|
|
614
|
-
| Area | Item | Status |
|
|
615
|
-
| ----------------------- | -------------------------------------------------------------------------------------------- | --------- |
|
|
616
|
-
| Presence | Redis reference implementation of `IPresenceStorage` — today the interface ships without one | Planned |
|
|
617
|
-
| Pub/sub adapters | Reference implementations beyond Redis (NATS, Redis Streams) for `IRealtimePubSub` | Exploring |
|
|
618
|
-
| Observability | Built-in metrics for connection counts, emit latency, and replay-buffer misses | Planned |
|
|
619
|
-
| Backpressure | Per-connection send queues with a configurable policy for slow consumers | Exploring |
|
|
620
|
-
| Client acknowledgements | Optional delivery receipts on the WebSocket transport | Exploring |
|
|
621
|
-
| Framework adapters | Vue and Svelte subpaths built on the same shared contracts | Exploring |
|
|
622
|
-
|
|
623
|
-
> Track progress and discuss proposals on the [issues board](https://github.com/bymaxone/nest-realtime/issues).
|
|
624
|
-
|
|
625
|
-
---
|
|
626
|
-
|
|
627
610
|
## 🤝 Contributing
|
|
628
611
|
|
|
629
612
|
Contributions are welcome! Please open an issue to discuss substantial changes before submitting a pull request.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymax-one/nest-realtime",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
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",
|
|
@@ -66,6 +66,28 @@
|
|
|
66
66
|
]
|
|
67
67
|
}
|
|
68
68
|
},
|
|
69
|
+
"scripts": {
|
|
70
|
+
"build": "pnpm clean && tsup",
|
|
71
|
+
"check:exports": "attw --pack . --profile strict",
|
|
72
|
+
"check:published": "node scripts/check-published-surface.mjs",
|
|
73
|
+
"clean": "rm -rf dist coverage",
|
|
74
|
+
"lint": "eslint src",
|
|
75
|
+
"lint:fix": "eslint src --fix",
|
|
76
|
+
"mutation": "stryker run",
|
|
77
|
+
"mutation:dry-run": "stryker run --dryRunOnly",
|
|
78
|
+
"mutation:incremental": "stryker run --incremental",
|
|
79
|
+
"prepublishOnly": "pnpm clean && pnpm typecheck && pnpm lint && pnpm test:cov:all && pnpm build && pnpm check:published",
|
|
80
|
+
"release": "pnpm publish --provenance",
|
|
81
|
+
"size": "node scripts/check-size.mjs",
|
|
82
|
+
"test": "jest",
|
|
83
|
+
"test:all": "pnpm test && pnpm test:e2e",
|
|
84
|
+
"test:cov": "jest --config jest.coverage.config.ts --coverage",
|
|
85
|
+
"test:cov:all": "jest --config jest.coverage.config.ts --coverage",
|
|
86
|
+
"test:e2e": "jest --config jest.e2e.config.ts",
|
|
87
|
+
"test:e2e:cross-instance": "jest --config jest.e2e.cross-instance.config.ts --runInBand",
|
|
88
|
+
"test:watch": "jest --watch",
|
|
89
|
+
"typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.server.json"
|
|
90
|
+
},
|
|
69
91
|
"peerDependencies": {
|
|
70
92
|
"@nestjs/common": "^11.0.16",
|
|
71
93
|
"@nestjs/core": "^11.1.18",
|
|
@@ -156,32 +178,28 @@
|
|
|
156
178
|
"tsup": "^8.0.0",
|
|
157
179
|
"typescript": "^5.6.0"
|
|
158
180
|
},
|
|
181
|
+
"packageManager": "pnpm@11.0.0",
|
|
159
182
|
"engines": {
|
|
160
183
|
"node": ">=24.0.0"
|
|
161
184
|
},
|
|
185
|
+
"keywords": [
|
|
186
|
+
"nestjs",
|
|
187
|
+
"realtime",
|
|
188
|
+
"sse",
|
|
189
|
+
"server-sent-events",
|
|
190
|
+
"websocket",
|
|
191
|
+
"socket.io",
|
|
192
|
+
"pubsub",
|
|
193
|
+
"redis",
|
|
194
|
+
"multi-tenant",
|
|
195
|
+
"presence",
|
|
196
|
+
"event-replay",
|
|
197
|
+
"offline-queue",
|
|
198
|
+
"react-hooks",
|
|
199
|
+
"typescript"
|
|
200
|
+
],
|
|
162
201
|
"publishConfig": {
|
|
163
202
|
"access": "public",
|
|
164
203
|
"registry": "https://registry.npmjs.org/"
|
|
165
|
-
},
|
|
166
|
-
"scripts": {
|
|
167
|
-
"build": "pnpm clean && tsup",
|
|
168
|
-
"check:exports": "attw --pack . --profile strict",
|
|
169
|
-
"check:published": "node scripts/check-published-surface.mjs",
|
|
170
|
-
"clean": "rm -rf dist coverage",
|
|
171
|
-
"lint": "eslint src",
|
|
172
|
-
"lint:fix": "eslint src --fix",
|
|
173
|
-
"mutation": "stryker run",
|
|
174
|
-
"mutation:dry-run": "stryker run --dryRunOnly",
|
|
175
|
-
"mutation:incremental": "stryker run --incremental",
|
|
176
|
-
"release": "pnpm publish --provenance",
|
|
177
|
-
"size": "node scripts/check-size.mjs",
|
|
178
|
-
"test": "jest",
|
|
179
|
-
"test:all": "pnpm test && pnpm test:e2e",
|
|
180
|
-
"test:cov": "jest --config jest.coverage.config.ts --coverage",
|
|
181
|
-
"test:cov:all": "jest --config jest.coverage.config.ts --coverage",
|
|
182
|
-
"test:e2e": "jest --config jest.e2e.config.ts",
|
|
183
|
-
"test:e2e:cross-instance": "jest --config jest.e2e.cross-instance.config.ts --runInBand",
|
|
184
|
-
"test:watch": "jest --watch",
|
|
185
|
-
"typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.server.json"
|
|
186
204
|
}
|
|
187
|
-
}
|
|
205
|
+
}
|