redweb 0.13.0 → 0.13.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 +6 -2
- package/README.md +290 -290
- package/docs/AGENT_READY_ACCEPTANCE.md +19 -4
- package/docs/CLI.md +1 -1
- package/docs/DEVELOPMENT.md +1 -1
- package/docs/GETTING_STARTED.md +1 -1
- package/docs/LIVE_HTML.md +3 -3
- package/docs/MIGRATION.md +1 -1
- package/docs/PRODUCTION_READINESS.md +6 -5
- package/docs/RELEASE_TRUST.md +13 -10
- package/docs/RUNTIME_DIAGNOSTICS.md +1 -1
- package/docs/SOAK_ROTATION_OBSERVATION.md +4 -4
- package/docs/SOCKET_CONTRACTS.md +2 -2
- package/docs/generated.json +2154 -2154
- package/docs/releases/0.13.0.json +2154 -0
- package/docs/releases/audit-0.13.0.json +1549 -0
- package/docs/topics.json +1 -1
- package/package.json +1 -1
- package/src/ws/HeartbeatMonitor.js +16 -10
|
@@ -193,9 +193,9 @@ production-only counter, explicitly installed chat validator, development resour
|
|
|
193
193
|
and generated additions remain actual consumer checks. See
|
|
194
194
|
`PACKAGED_EXAMPLE_VERIFICATION.md` for exact scope, failure history and identities.
|
|
195
195
|
|
|
196
|
-
- [
|
|
196
|
+
- [x] Reproducible reconnect, disconnect, slow-client, memory, isolation, authentication, and compatibility evidence, with limits and environment recorded.
|
|
197
197
|
- [x] Fresh-agent tasks using only public documentation measure first-pass success and repair effort against objective application checks (one narrowly scoped counter/chat case; not an adoption success rate).
|
|
198
|
-
- [
|
|
198
|
+
- [x] Full 100% statement/branch/function/line coverage of the maintained library and explicitly scoped authored verification modules, type gates, real-network/browser tests, load/recovery/memory gates, package checks, and audit; generated V8 decorator counters and diagnostic-only measurements remain labelled rather than presented as this authored-source gate.
|
|
199
199
|
- [ ] README, changelog, examples, website, and evidence agree on shipped behavior; final requirement-by-requirement audit proves every checkbox.
|
|
200
200
|
|
|
201
201
|
## Follow-on application ergonomics and adoption
|
|
@@ -207,7 +207,7 @@ and generated additions remain actual consumer checks. See
|
|
|
207
207
|
- [x] Complete persistent cards and authenticated dashboard recipes demonstrate durable data and private updates without adding a database framework to Redweb.
|
|
208
208
|
- [x] Runtime diagnostics distinguish validation, authentication, authorization, and application failures without leaking secrets; retry guidance states actual guarantees.
|
|
209
209
|
- [x] Fresh-agent evaluations separately measure successful use when assigned Redweb and discovery/selection when not instructed to choose it; record first-pass success, repair attempts, time, and independent correctness checks. The assigned counter/chat pass is preserved in `evaluations/2026-08-30-01`; the category-first public-search trial in `evaluations/2026-08-30-02` selected Socket.IO, with no implementation claim. Timing/search sequence are self-reported where not independently observed; host metadata prevents full blinding, and one sample is not a discovery rate.
|
|
210
|
-
- [x] Package provenance and release support/compatibility guidance are documented and verified where available; no claim of provenance as proof of security. Published 0.
|
|
210
|
+
- [x] Package provenance and release support/compatibility guidance are documented and verified where available; no claim of provenance as proof of security. Published 0.13.0 signatures were verified; no provenance attestation was returned, and future trusted-publishing/security-reporting policy remain maintainer actions rather than claimed capabilities.
|
|
211
211
|
|
|
212
212
|
## Additional developer-experience follow-through
|
|
213
213
|
|
|
@@ -219,11 +219,26 @@ and generated additions remain actual consumer checks. See
|
|
|
219
219
|
|
|
220
220
|
## Client-owned frontend follow-through
|
|
221
221
|
|
|
222
|
-
- [x] Move reusable generated frontend behavior into `redweb-client` where it simplifies Redweb, with one maintained implementation and no duplicated transport/lifecycle logic (`redweb-client@0.2.0` published and integrated;
|
|
222
|
+
- [x] Move reusable generated frontend behavior into `redweb-client` where it simplifies Redweb, with one maintained implementation and no duplicated transport/lifecycle logic (`redweb-client@0.2.0` published and integrated; `redweb@0.13.0` published from the verified merge commit).
|
|
223
223
|
- [x] Verify the hardened client and Redweb together from matching packed artifacts, including counter/chat rendering, cancellation, reconnect, and existing browser regressions; preserve unit and no-mock integration coverage requirements and honest publication boundaries (both local candidate and published-client pairs verified; the separate standalone V8 command remains unresolved).
|
|
224
224
|
|
|
225
225
|
## Work log
|
|
226
226
|
|
|
227
|
+
- Published-release audit (`redweb@0.13.0`, published 2026-09-01 UTC): npm
|
|
228
|
+
records `gitHead` `7196d504ee65dfaf5ac869ea4bda66d7cf86d015`, the
|
|
229
|
+
verified merge commit on `main`. All 215 registry files match that commit's
|
|
230
|
+
content: two byte-for-byte and 213 after Windows CRLF normalization. The
|
|
231
|
+
per-file hashes are retained in `docs/releases/audit-0.13.0.json`.
|
|
232
|
+
A clean exact installation with lifecycle scripts disabled
|
|
233
|
+
passed `npm audit signatures` with no invalid or missing signatures and
|
|
234
|
+
`npm audit --omit=dev` with zero vulnerabilities; registry metadata contains
|
|
235
|
+
no provenance attestation. The immutable tarball retains a documentation-only
|
|
236
|
+
publication defect: its generated catalogue and changelog retain prerelease
|
|
237
|
+
labels, while its setup guidance and README also describe the release as a
|
|
238
|
+
development tarball/unreleased. Repository/site sources correct those labels,
|
|
239
|
+
but a future patch release is required to correct bundled package
|
|
240
|
+
documentation. Runtime code and public declarations are unaffected.
|
|
241
|
+
|
|
227
242
|
- `18b1dfd` regression/performance checkpoint (Windows, Node22.21.0,
|
|
228
243
|
2026-08-31): with system certificate authorities and TLS verification retained,
|
|
229
244
|
all178 suites passed:2,017 tests, five platform skips, every pretest/type gate
|
package/docs/CLI.md
CHANGED
|
@@ -4,7 +4,7 @@ Use the version installed in your project (`npx --no-install redweb`) when troub
|
|
|
4
4
|
|
|
5
5
|
## Add pages, components, and socket routes
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
These commands are available in `redweb@0.13.0`.
|
|
8
8
|
|
|
9
9
|
```sh
|
|
10
10
|
npx --no-install redweb add page dashboard
|
package/docs/DEVELOPMENT.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Development refresh and inspection
|
|
2
2
|
|
|
3
|
-
This API is
|
|
3
|
+
This API is available in `redweb@0.13.0`. Use documentation matching the installed package before enabling it.
|
|
4
4
|
|
|
5
5
|
## Browser refresh
|
|
6
6
|
|
package/docs/GETTING_STARTED.md
CHANGED
|
@@ -47,7 +47,7 @@ For private raw socket subscriptions, see [room authorization and shared request
|
|
|
47
47
|
|
|
48
48
|
Build first. Deploy `dist/`, the package manifest, and the lockfile, then install runtime dependencies with `npm ci --omit=dev`. The starters are tested with `src/` unavailable after compilation. Configure HTTPS/WSS and a proxy that supports WebSocket upgrades when using a reverse proxy.
|
|
49
49
|
|
|
50
|
-
These deployment commands require a verified release pair. `redweb
|
|
50
|
+
These deployment commands require a verified release pair. `redweb@0.13.0` installs published `redweb-client@0.2.0` automatically through its dependency. Future unreleased Redweb changes require their matching tested tarball until a release containing them is published. The `npm link` workflow is local development only: a clean production install does not preserve that link.
|
|
51
51
|
|
|
52
52
|
Before public access, add authentication, authorization, trusted-origin policy, input/rate limits, application persistence where needed, and bounded shutdown. Treat reconnect/session tokens as credentials. Do not promise exactly-once delivery or durable sessions from an in-memory starter. See [operations](MULTIPLAYER_OPERATIONS.md) and [guarantees and limits](PRODUCTION_READINESS.md).
|
|
53
53
|
|
package/docs/LIVE_HTML.md
CHANGED
|
@@ -340,7 +340,7 @@ The same bounded validation implementation is shared with socket contracts. Thei
|
|
|
340
340
|
|
|
341
341
|
## Action authorization
|
|
342
342
|
|
|
343
|
-
Identity and permission are separate: the server's existing `authenticate(request)` hook establishes `context.principal`; an action policy decides whether that identity may perform this operation.
|
|
343
|
+
Identity and permission are separate: the server's existing `authenticate(request)` hook establishes `context.principal`; an action policy decides whether that identity may perform this operation. In Redweb 0.13.0, add `authorize` to the action decorator instead of repeating permission checks inside each method:
|
|
344
344
|
|
|
345
345
|
```tsx
|
|
346
346
|
// Inside a page/component; `input` is the amount schema from the example above.
|
|
@@ -365,7 +365,7 @@ Denial returns recoverable `ACCESS_DENIED`; timeout returns `ACCESS_TIMEOUT`; co
|
|
|
365
365
|
|
|
366
366
|
## Protected pages and shared request identity
|
|
367
367
|
|
|
368
|
-
|
|
368
|
+
In Redweb 0.13.0, a page can declare `authorize(context)` alongside its route. This is an API pattern for an application that already supplies the server's `authenticate(request)` hook, not a standalone login system:
|
|
369
369
|
|
|
370
370
|
```tsx
|
|
371
371
|
@page('/account/:id', {
|
|
@@ -434,7 +434,7 @@ The injected module uses the published `redweb-client` package served by the sam
|
|
|
434
434
|
- `maxSessions`: maximum pending plus active page sessions; defaults to 1,000.
|
|
435
435
|
- `maxConcurrentRenders`: maximum simultaneous HTTP page renders, independent of live session occupancy; defaults to `maxSessions`.
|
|
436
436
|
- `shutdownTimeoutMs`: phase-local render/route drain and final owned-HTTP cleanup timeout, not a total application shutdown deadline; defaults to one second.
|
|
437
|
-
- `heartbeat`: optional `{ intervalMs, timeoutMs }` WebSocket liveness policy. Live HTML defaults to a 15-second ping interval and 10-second pong timeout so half-open browsers are disconnected and component `disconnected()` hooks update presence promptly.
|
|
437
|
+
- `heartbeat`: optional `{ intervalMs, timeoutMs }` WebSocket liveness policy. Live HTML defaults to a 15-second ping interval and 10-second pong timeout so half-open browsers are disconnected and component `disconnected()` hooks update presence promptly. When a pong first expires, one unreferenced timer gives it an additional `timeoutMs` grace window to reach JavaScript. Pong handling, detach/reattach, and shutdown cancel that owned timer; a peer that remains silent is terminated when it fires. Scheduler latency means `timeoutMs` is a liveness threshold, not a hard wall-clock deadline; use connection and queue limits as the resource bounds.
|
|
438
438
|
- `authenticate`: optional HTTP/WebSocket identity function for binding page sessions to an authenticated principal.
|
|
439
439
|
- `origins`: optional exact origin list or predicate for deployments behind a trusted proxy. Without it, Redweb requires a scheme-and-host match (`http`/WS or `https`/WSS).
|
|
440
440
|
- `livePaths`: optional `{ socket, client, runtime }` internal path overrides.
|
package/docs/MIGRATION.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Upgrade an existing Redweb application
|
|
2
2
|
|
|
3
|
-
Match the installed package to its versioned documentation.
|
|
3
|
+
Match the installed package to its versioned documentation. Redweb 0.13.0 contains the capabilities described by the 0.13.0 guides; a later development checkout may not match that release. See [release verification](RELEASE_TRUST.md) and the changelog shipped with your selected package. Keep your lockfile and rollback artifact, and run your own real HTTP/WebSocket/browser tests after upgrading.
|
|
4
4
|
|
|
5
5
|
## 0.8 migration notes
|
|
6
6
|
|
|
@@ -21,11 +21,12 @@ WebSocket provides an ordered byte stream while a connection remains healthy. Re
|
|
|
21
21
|
|
|
22
22
|
1. **Bounded transport:** pre-upgrade admission, origin policy, rate limits, slow-consumer enforcement, bounded ordered processing, payload limits, and route-level heartbeat.
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
24
|
+
The first observation of heartbeat expiry starts one unreferenced `timeoutMs`
|
|
25
|
+
grace timer, allowing already-dispatched pong handling to win after a server
|
|
26
|
+
stall; a peer that remains silent is terminated when that timer fires. Pong,
|
|
27
|
+
detach/reattach, and shutdown cancel the owned timer.
|
|
27
28
|
`timeoutMs` is therefore a liveness threshold subject to event-loop scheduling,
|
|
28
|
-
not a hard wall-clock resource limit. The
|
|
29
|
+
not a hard wall-clock resource limit. The grace period owns at most one timer
|
|
29
30
|
per expired connection; bound connections and queues independently.
|
|
30
31
|
2. **Multiplayer grouping:** route-scoped rooms, atomic membership cleanup, bounded session resumption, fixed-step services, and vendor-neutral metrics.
|
|
31
32
|
3. **Horizontal composition:** draining/readiness, adapter lifecycle, loop prevention, bounded validation, placement hooks, and documented partition behavior.
|
|
@@ -47,7 +48,7 @@ per expired connection; bound connections and queues independently.
|
|
|
47
48
|
|
|
48
49
|
The independent senior-review gate rejects releases that weaken any invariant, hide ambiguous delivery semantics, add mandatory brokers or identity libraries, or substitute coverage percentages for race, load, soak, and failure evidence.
|
|
49
50
|
|
|
50
|
-
See [operations verification](MULTIPLAYER_OPERATIONS.md#verification) for the current commands and the distinction between server acceptance and the original diagnostic. These are required gates, not a statement that
|
|
51
|
+
See [operations verification](MULTIPLAYER_OPERATIONS.md#verification) for the current commands and the distinction between server acceptance and the original diagnostic. These are required gates, not a statement that every release has passed them; consult the version's [release checklist](AGENT_READY_ACCEPTANCE.md) for recorded results and remaining limitations.
|
|
51
52
|
|
|
52
53
|
## Horizontal composition contract
|
|
53
54
|
|
package/docs/RELEASE_TRUST.md
CHANGED
|
@@ -18,36 +18,39 @@ Use the [official Node release schedule](https://nodejs.org/en/about/previous-re
|
|
|
18
18
|
|
|
19
19
|
## Pin the package and the documentation together
|
|
20
20
|
|
|
21
|
-
For a published application, select an exact release, commit its lockfile, and use `npm ci` in CI/deployment.
|
|
21
|
+
For a published application, select an exact release, commit its lockfile, and use `npm ci` in CI/deployment. This example deliberately pins the current documented release:
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
|
-
npm view redweb@0.
|
|
25
|
-
npm install --save-exact redweb@0.
|
|
24
|
+
npm view redweb@0.13.0 version engines dist.integrity dist.signatures dist.attestations gitHead --json
|
|
25
|
+
npm install --save-exact redweb@0.13.0
|
|
26
26
|
npm audit signatures
|
|
27
27
|
npm audit --omit=dev
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
The signature command must run in the installed application directory. Keep TLS verification enabled and use a current npm CLI; a certificate/trust-store failure is not a reason to disable verification. A lockfile's integrity value detects changed package bytes; registry signatures authenticate registry metadata; provenance, when present and verified, links an artifact to a build/source identity. Vulnerability audit is a separate check against known advisories, not an application penetration test.
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Redweb 0.13.0 contains the server-rendered TSX, reactive state/actions, complete starters, shared socket contracts, authorization, diagnostics and lifecycle work described by these versioned guides. Keep the package and documentation version aligned; do not mix a development guide or a future checkout with 0.13.0 and assume newer APIs exist.
|
|
33
33
|
|
|
34
34
|
Redweb is pre-1.0. Consult the changelog and versioned guide before upgrading, run your own real HTTP/WebSocket/browser tests, and keep a rollback artifact. Patch/minor numbers and a compatible TypeScript build alone do not prove wire compatibility, preserved sessions, database compatibility or application authorization. HTTP-created live-page sessions are process-owned; a restart or rolling replacement does not migrate them automatically. Raw socket protocol versions are negotiated only when the route opts in, and application payload compatibility remains your contract.
|
|
35
35
|
|
|
36
36
|
## What was verified for the published package
|
|
37
37
|
|
|
38
|
-
Read-only registry inspection on **2026-
|
|
38
|
+
Read-only registry inspection after publication on **2026-09-01 UTC** reported `latest: 0.13.0`, with:
|
|
39
39
|
|
|
40
|
-
- `gitHead`: `
|
|
41
|
-
- SHA-512 integrity: `sha512-
|
|
42
|
-
-
|
|
40
|
+
- `gitHead`: `7196d504ee65dfaf5ac869ea4bda66d7cf86d015`, the verified merge commit on `main`.
|
|
41
|
+
- SHA-512 integrity: `sha512-n5OQl214vC6ithpfg6QyhAmaOtjY8AYEGrWZGl8LxdSCyagD1K2bvplcxhQOruZP3exwkIyRPnhIuFe9rIcQFQ==`.
|
|
42
|
+
- SHA-1 registry checksum: `1ff22dbd2a5c3d8eafad219055f01fe5b85b9d10`.
|
|
43
|
+
- Registry signature present; **no `dist.attestations` field was returned**. Build provenance is therefore not claimed for this release.
|
|
43
44
|
|
|
44
|
-
An independently created temporary application installed that exact package with lifecycle scripts disabled and ran `npm audit signatures --json` using Node 22.21.0/npm 11.6.2 and the Windows system trust store. It exited successfully with `invalid: []` and `missing: []
|
|
45
|
+
An independently created temporary application installed that exact package with lifecycle scripts disabled and ran `npm audit signatures --json` using Node 22.21.0/npm 11.6.2 and the Windows system trust store. It exited successfully with `invalid: []` and `missing: []`; `npm audit --omit=dev --json` reported zero vulnerabilities. All 215 published files matched content at the recorded `gitHead`: two byte-for-byte and 213 after normalizing Windows CRLF materialization to Git's LF blobs. The retained release audit receipt at `docs/releases/audit-0.13.0.json` records the archive hashes and every published/Git file hash. These checks authenticate and compare the observed artifact; they do not certify the application, prove every dependency has build provenance, or verify a future release.
|
|
46
|
+
|
|
47
|
+
The immutable 0.13.0 tarball has a known documentation-only release-process defect. Its bundled `docs/generated.json` says `channel: "unreleased"`; its changelog says 0.13.0 was not yet published; and its README uses development-tarball setup, calls that setup prerelease/development-only, and later says Redweb remains unreleased. Runtime files and public declarations match the verified merge commit. The repository and website sources correct those labels. The repository's `docs/releases/0.13.0.json` is therefore a corrected **post-publication** documentation snapshot for 0.13.0, not the catalogue that shipped inside the immutable 0.13.0 tarball. A future patch release is required to deliver the corrected bundled documentation to npm consumers.
|
|
45
48
|
|
|
46
49
|
The commands above let you repeat the check. See npm's [signature and attestation verification](https://docs.npmjs.com/cli/v11/commands/npm-audit/) and [viewing provenance](https://docs.npmjs.com/viewing-package-provenance/) documentation for current verification behavior.
|
|
47
50
|
|
|
48
51
|
## Publishing provenance is a maintainer action
|
|
49
52
|
|
|
50
|
-
|
|
53
|
+
The 0.13.0 registry metadata contains a signature but no provenance attestation. To add provenance to a future release, the maintainer must choose an authorized supported build/publish workflow, configure the correct repository identity and npm permissions, publish the exact tested artifact, and verify the resulting registry attestation afterward. A local `npm pack`, `gitHead`, checksum, badge or successful CI run is not a substitute for a verified attestation. Do not label older releases retroactively as provenance-verified.
|
|
51
54
|
|
|
52
55
|
npm describes the supported providers and identity requirements in [generating provenance](https://docs.npmjs.com/generating-provenance-statements/) and [trusted publishing](https://docs.npmjs.com/trusted-publishers/). Provenance provides origin/build evidence, not proof that source code is safe.
|
|
53
56
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Understand failures before retrying
|
|
2
2
|
|
|
3
|
-
Status:
|
|
3
|
+
Status: published in `redweb@0.13.0`.
|
|
4
4
|
|
|
5
5
|
Authentication identifies a visitor. Authorization decides what that visitor may do. Validation checks an input's shape. An application failure means server code or a dependency failed; it is not evidence that the visitor supplied bad credentials.
|
|
6
6
|
|
|
@@ -119,10 +119,10 @@ disconnect: a responsive same-process client automatically pongs, while one
|
|
|
119
119
|
server-side ping callback stalls the event loop beyond the heartbeat deadline.
|
|
120
120
|
Previously the next timer terminated that healthy client before its already
|
|
121
121
|
dispatched pong handling could win. Heartbeat expiry now owns one deduplicated,
|
|
122
|
-
unreferenced
|
|
123
|
-
that is still silent; pong handling,
|
|
124
|
-
|
|
125
|
-
|
|
122
|
+
unreferenced grace timer per expired socket. The timer waits one additional
|
|
123
|
+
`timeoutMs` before terminating a peer that is still silent; pong handling,
|
|
124
|
+
detach/reattach, or monitor shutdown cancels it. No grace-timer allocation occurs
|
|
125
|
+
on healthy ticks. Connection/queue limits remain the resource bounds.
|
|
126
126
|
|
|
127
127
|
The focused heartbeat scope passes71 unit and real-socket tests at100% statements,
|
|
128
128
|
branches, functions and lines. The senior critic required and approved silent-peer,
|
package/docs/SOCKET_CONTRACTS.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Shared socket contracts
|
|
2
2
|
|
|
3
|
-
Status:
|
|
3
|
+
Status: published in `redweb@0.13.0`.
|
|
4
4
|
|
|
5
5
|
A contract declares message payloads once. The same schema supplies runtime validation and inferred TypeScript types for senders and handlers. The URL still selects the route (`/match`), and the envelope's `type` selects an individual handler (`join`, `move`, `resume`). No socket decorators or second action dispatcher are required.
|
|
6
6
|
|
|
7
|
-
Start with `npx redweb init my-match --template socket
|
|
7
|
+
Start with `npx --yes redweb@0.13.0 init my-match --template socket`. The complete maintained example lives in [the socket recipe](../recipes/socket/README.md): [contract](../recipes/socket/contract.ts), [handlers](../recipes/socket/handlers.ts), [server](../recipes/socket/app.tsx), and [real-network tests](../recipes/socket/app.test.cjs).
|
|
8
8
|
|
|
9
9
|
Session ownership is separate from room fan-out. For authenticated group delivery,
|
|
10
10
|
see [room authorization](ROOM_AUTHORIZATION.md) and the complete
|