redweb 0.16.3 → 0.16.4
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 +5 -0
- package/README.md +3 -3
- package/docs/CLI.md +1 -1
- package/docs/DEVELOPMENT.md +1 -1
- package/docs/GETTING_STARTED.md +4 -4
- package/docs/LIVE_HTML.md +1 -1
- package/docs/MIGRATION.md +1 -1
- package/docs/RELEASE_TRUST.md +4 -4
- package/docs/SOCKET_CONTRACTS.md +1 -1
- package/docs/generated.json +226 -222
- package/docs/reference.json +6 -2
- package/docs/releases/0.16.4.json +2290 -0
- package/index.d.ts +4 -1
- package/index.js +2 -1
- package/package.json +6 -2
- package/src/htmx/CodeHighlight.js +98 -0
- package/src/htmx/Html.js +4 -3
- package/src/htmx/index.js +2 -1
- package/styles/code-highlight.css +16 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.16.4
|
|
4
|
+
|
|
5
|
+
- Highlight JavaScript, TypeScript and TSX code blocks by default, including object and handler references inside `rw-*={...}` bindings. Export the safe `highlightCode()` helper and optional `redweb/code-highlight.css` palette for applications that render documentation.
|
|
6
|
+
- Keep custom highlighters, already-composed HTML fragments, and `highlight: false` available. Verify escaping and tokenization with 100% unit coverage and a real HTTP page test.
|
|
7
|
+
|
|
3
8
|
## 0.16.3
|
|
4
9
|
|
|
5
10
|
- Add explicit `defineApp({ providers })` dependencies through `@inject`, keyed `liveResource()` and `@resource()` projections, and bounded streaming `@upload()` actions for Live HTML pages and components.
|
package/README.md
CHANGED
|
@@ -11,12 +11,12 @@ Use the same package for a live site, static HTML, Express HTTP endpoints, or ro
|
|
|
11
11
|
Start with a neutral, tested application foundation:
|
|
12
12
|
|
|
13
13
|
<!-- redweb:setup:start -->
|
|
14
|
-
> Documentation for Redweb 0.16.
|
|
14
|
+
> Documentation for Redweb 0.16.4. Install that exact version when following these examples.
|
|
15
15
|
|
|
16
16
|
```sh
|
|
17
|
-
npx --yes redweb@0.16.
|
|
17
|
+
npx --yes redweb@0.16.4 init my-app
|
|
18
18
|
cd my-app
|
|
19
|
-
npm install --save-exact redweb@0.16.
|
|
19
|
+
npm install --save-exact redweb@0.16.4
|
|
20
20
|
npm test
|
|
21
21
|
npm run dev
|
|
22
22
|
```
|
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
|
-
These commands are available in `redweb@0.16.
|
|
7
|
+
These commands are available in `redweb@0.16.4`.
|
|
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 available in `redweb@0.16.
|
|
3
|
+
This API is available in `redweb@0.16.4`. Use documentation matching the installed package before enabling it.
|
|
4
4
|
|
|
5
5
|
## Browser refresh
|
|
6
6
|
|
package/docs/GETTING_STARTED.md
CHANGED
|
@@ -9,9 +9,9 @@ It is not React, a browser component framework, a database, an identity provider
|
|
|
9
9
|
Create the same neutral foundation whether you are following a tutorial or starting your own application:
|
|
10
10
|
|
|
11
11
|
```sh
|
|
12
|
-
npx --yes redweb@0.16.
|
|
12
|
+
npx --yes redweb@0.16.4 init my-app
|
|
13
13
|
cd my-app
|
|
14
|
-
npm install --save-exact redweb@0.16.
|
|
14
|
+
npm install --save-exact redweb@0.16.4
|
|
15
15
|
npm test
|
|
16
16
|
npm run dev
|
|
17
17
|
```
|
|
@@ -19,7 +19,7 @@ npm run dev
|
|
|
19
19
|
Add capability dependencies without importing example-domain code:
|
|
20
20
|
|
|
21
21
|
```sh
|
|
22
|
-
npx --yes redweb@0.16.
|
|
22
|
+
npx --yes redweb@0.16.4 init my-game --with auth,multiplayer
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
The default includes its real tests. `--bare` omits only the test directory, test scripts, and test-only coverage dependency; it retains the runnable application, CSS, compiler configuration, build scripts, and development watcher.
|
|
@@ -67,7 +67,7 @@ For private raw socket subscriptions, see [room authorization and shared request
|
|
|
67
67
|
|
|
68
68
|
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.
|
|
69
69
|
|
|
70
|
-
These deployment commands require a verified release pair. `redweb@0.16.
|
|
70
|
+
These deployment commands require a verified release pair. `redweb@0.16.4` installs published `redweb-client@0.3.1` 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.
|
|
71
71
|
|
|
72
72
|
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).
|
|
73
73
|
|
package/docs/LIVE_HTML.md
CHANGED
|
@@ -205,7 +205,7 @@ const reference = <>{apiSections.map(section =>
|
|
|
205
205
|
)}</>;
|
|
206
206
|
```
|
|
207
207
|
|
|
208
|
-
`codeBlock()` escapes strings by default.
|
|
208
|
+
`codeBlock()` escapes strings by default. JavaScript, TypeScript, and TSX strings are highlighted automatically, including identifiers inside `rw-*={...}` action bindings. The built-in `highlightCode(source, language)` is also available when composing custom code UI. Both emit escaped `token-keyword`, `token-literal`, `token-number`, `token-string`, `token-comment`, and `token-reference` spans. Copy or import `redweb/code-highlight.css` for a default dark palette, or style those classes in your own CSS. Other languages remain escaped plain text. An explicit `HtmlFragment` remains untouched, `highlight: false` opts out, and a custom `highlight(source, language)` callback overrides the built-in highlighter. A custom callback must return a safe fragment, not arbitrary HTML.
|
|
209
209
|
|
|
210
210
|
An `HtmlFragment` returned from `render()` is already fully composed and is never reparsed for `{{ bindings }}` or directives. This keeps code samples literal and prevents escaped documentation text from becoming executable template syntax. Return a string or use `template` when Redweb should process declarative bindings.
|
|
211
211
|
|
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. Redweb 0.16.
|
|
3
|
+
Match the installed package to its versioned documentation. Redweb 0.16.4 contains the capabilities described by the 0.16.4 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
|
|
package/docs/RELEASE_TRUST.md
CHANGED
|
@@ -41,18 +41,18 @@ An ordinary installation without this root policy can still select affected
|
|
|
41
41
|
dependencies. No Express 5 migration, bundled fork or published shrinkwrap is
|
|
42
42
|
introduced. Audit results remain time-sensitive and application-specific.
|
|
43
43
|
|
|
44
|
-
For a published application, select an exact release, commit its lockfile, and use `npm ci` in CI/deployment. This guide is versioned for 0.16.
|
|
44
|
+
For a published application, select an exact release, commit its lockfile, and use `npm ci` in CI/deployment. This guide is versioned for 0.16.4. Before registry publication, verify the packed candidate; after publication, repeat these registry checks from a clean application:
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
|
-
npm view redweb@0.16.
|
|
48
|
-
npm install --save-exact redweb@0.16.
|
|
47
|
+
npm view redweb@0.16.4 version engines dist.integrity dist.signatures dist.attestations gitHead --json
|
|
48
|
+
npm install --save-exact redweb@0.16.4
|
|
49
49
|
npm audit signatures
|
|
50
50
|
npm audit --omit=dev
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
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.
|
|
54
54
|
|
|
55
|
-
Redweb 0.16.
|
|
55
|
+
Redweb 0.16.4 contains neutral composable initialization, socket-bound TSX controls and connection-owned page state, unified application startup, server-rendered TSX, reactive state/actions, explicit providers, keyed live resources, bounded streaming uploads, built-in code highlighting, complete starters, shared socket contracts, authorization, diagnostics, lifecycle work, and bounded heartbeat grace described by these versioned guides. Keep the package and documentation version aligned; do not mix a development guide or a future checkout with 0.16.4 and assume newer APIs exist.
|
|
56
56
|
|
|
57
57
|
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.
|
|
58
58
|
|
package/docs/SOCKET_CONTRACTS.md
CHANGED
|
@@ -4,7 +4,7 @@ Status: included since `redweb@0.16.2`.
|
|
|
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 --yes redweb@0.16.
|
|
7
|
+
Start with `npx --yes redweb@0.16.4 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
|