Skip to content

Commit eb3fcea

Browse files
manuel-lohmusmanuel-lohmus
committed
v1.1.0
1 parent bec69c4 commit eb3fcea

2 files changed

Lines changed: 62 additions & 58 deletions

File tree

‎README.html‎

Lines changed: 51 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2342,19 +2342,17 @@ <h1 data-line="5" class="code-line" dir="auto" id="ws13--websocket-api-v110" tab
23422342
v1.1.0</h1>
23432343
<p data-line="7" class="code-line" dir="auto">Modular, extensible and operations-friendly WebSocket framework for
23442344
Node.js. This release focuses on a small, stable core so dependent projects can proceed; extensions (<a
2345-
href="./extensions/channels/README.html"
2346-
data-href="./extensions/channels/README.html"><code>channels</code></a>, <a
2347-
href="./extensions/auth/README.html" data-href="./extensions/auth/README.html"><code>auth</code></a>, <a
2348-
href="./extensions/history/README.html"
2349-
data-href="./extensions/history/README.html"><code>history</code></a>, <a
2350-
href="./extensions/events/README.html" data-href="./extensions/events/README.html"><code>events</code></a>,
2351-
<a href="./extensions/admin/README.html" data-href="./extensions/admin/README.html"><code>admin</code></a>, <a
2352-
href="./extensions/routing/README.html"
2353-
data-href="./extensions/routing/README.html"><code>routing</code></a>, <a
2354-
href="./extensions/heartbeat/README.html"
2355-
data-href="./extensions/heartbeat/README.html"><code>heartbeat</code></a>, <a
2356-
href="./extensions/message-meta/README.html"
2357-
data-href="./extensions/message-meta/README.html"><code>message-meta</code></a>,
2345+
href="./extensions/channels/README.md"
2346+
data-href="./extensions/channels/README.md"><code>channels</code></a>, <a href="./extensions/auth/README.md"
2347+
data-href="./extensions/auth/README.md"><code>auth</code></a>, <a href="./extensions/history/README.md"
2348+
data-href="./extensions/history/README.md"><code>history</code></a>, <a href="./extensions/events/README.md"
2349+
data-href="./extensions/events/README.md"><code>events</code></a>, <a href="./extensions/admin/README.md"
2350+
data-href="./extensions/admin/README.md"><code>admin</code></a>, <a href="./extensions/routing/README.md"
2351+
data-href="./extensions/routing/README.md"><code>routing</code></a>, <a
2352+
href="./extensions/heartbeat/README.md"
2353+
data-href="./extensions/heartbeat/README.md"><code>heartbeat</code></a>, <a
2354+
href="./extensions/message-meta/README.md"
2355+
data-href="./extensions/message-meta/README.md"><code>message-meta</code></a>,
23582356
<code>permessage-deflate</code>) exist as planned work and will be completed and documented in follow-up
23592357
releases.</p>
23602358
<p data-line="9" class="code-line" dir="auto">Status: core stable and testable — extensions work in progress (APIs
@@ -2397,18 +2395,16 @@ <h2 data-line="25" class="code-line" dir="auto" id="-highlights-v110" tabindex="
23972395
<li data-line="33" class="code-line" dir="auto">Tests included for core registry and basic behaviour (see
23982396
'index.test.js').</li>
23992397
</ul>
2400-
<p data-line="35" class="code-line" dir="auto">Extensions (<a href="./extensions/channels/README.html"
2401-
data-href="./extensions/channels/README.html"><code>channels</code></a>, <a
2402-
href="./extensions/events/README.html" data-href="./extensions/events/README.html"><code>events</code></a>,
2403-
<a href="./extensions/history/README.html"
2404-
data-href="./extensions/history/README.html"><code>history</code></a>, <a
2405-
href="./extensions/admin/README.html" data-href="./extensions/admin/README.html"><code>admin</code></a>, <a
2406-
href="./extensions/routing/README.html"
2407-
data-href="./extensions/routing/README.html"><code>routing</code></a>, <a
2408-
href="./extensions/message-meta/README.html"
2409-
data-href="./extensions/message-meta/README.html"><code>message-meta</code></a>, <a
2410-
href="./extensions/heartbeat/README.html"
2411-
data-href="./extensions/heartbeat/README.html"><code>heartbeat</code></a>) are available as separate modules
2398+
<p data-line="35" class="code-line" dir="auto">Extensions (<a href="./extensions/channels/README.md"
2399+
data-href="./extensions/channels/README.md"><code>channels</code></a>, <a
2400+
href="./extensions/events/README.md" data-href="./extensions/events/README.md"><code>events</code></a>, <a
2401+
href="./extensions/history/README.md" data-href="./extensions/history/README.md"><code>history</code></a>,
2402+
<a href="./extensions/admin/README.md" data-href="./extensions/admin/README.md"><code>admin</code></a>, <a
2403+
href="./extensions/routing/README.md" data-href="./extensions/routing/README.md"><code>routing</code></a>,
2404+
<a href="./extensions/message-meta/README.md"
2405+
data-href="./extensions/message-meta/README.md"><code>message-meta</code></a>, <a
2406+
href="./extensions/heartbeat/README.md"
2407+
data-href="./extensions/heartbeat/README.md"><code>heartbeat</code></a>) are available as separate modules
24122408
in the repo but marked WIP — README below points to that.</p>
24132409
<div data-line="37" class="code-line" dir="auto"></div>
24142410
<p align="right"><a href="#ws13-logo">Back to top ↑</a></p>
@@ -2513,28 +2509,28 @@ <h2 data-line="144" class="code-line" dir="auto" id="-extension-roadmap-short" t
25132509
documented and stabilised in subsequent releases.
25142510
Current status: prototype/partial implementations present in repo.</p>
25152511
<ul data-line="149" class="code-line" dir="auto">
2516-
<li data-line="149" class="code-line" dir="auto"><a href="./extensions/channels/README.html"
2517-
data-href="./extensions/channels/README.html"><code>channels</code></a> — channel-based pub/sub</li>
2518-
<li data-line="150" class="code-line" dir="auto"><a href="./extensions/message-meta/README.html"
2519-
data-href="./extensions/message-meta/README.html"><code>message-meta</code></a> — typed messages with
2520-
meta (wrap/unwrap)</li>
2521-
<li data-line="151" class="code-line" dir="auto"><a href="./extensions/heartbeat/README.html"
2522-
data-href="./extensions/heartbeat/README.html"><code>heartbeat</code></a> — idle/timeout hooks and
2523-
monitor</li>
2524-
<li data-line="152" class="code-line" dir="auto"><a href="./extensions/history/README.html"
2525-
data-href="./extensions/history/README.html"><code>history</code></a> — per-channel replay buffer (last
2526-
N messages)</li>
2527-
<li data-line="153" class="code-line" dir="auto"><a href="./extensions/events/README.html"
2528-
data-href="./extensions/events/README.html"><code>events</code></a> — JSON-RPC style event emitter
2512+
<li data-line="149" class="code-line" dir="auto"><a href="./extensions/channels/README.md"
2513+
data-href="./extensions/channels/README.md"><code>channels</code></a> — channel-based pub/sub</li>
2514+
<li data-line="150" class="code-line" dir="auto"><a href="./extensions/message-meta/README.md"
2515+
data-href="./extensions/message-meta/README.md"><code>message-meta</code></a> — typed messages with meta
2516+
(wrap/unwrap)</li>
2517+
<li data-line="151" class="code-line" dir="auto"><a href="./extensions/heartbeat/README.md"
2518+
data-href="./extensions/heartbeat/README.md"><code>heartbeat</code></a> — idle/timeout hooks and monitor
2519+
</li>
2520+
<li data-line="152" class="code-line" dir="auto"><a href="./extensions/history/README.md"
2521+
data-href="./extensions/history/README.md"><code>history</code></a> — per-channel replay buffer (last N
2522+
messages)</li>
2523+
<li data-line="153" class="code-line" dir="auto"><a href="./extensions/events/README.md"
2524+
data-href="./extensions/events/README.md"><code>events</code></a> — JSON-RPC style event emitter
25292525
(ws.onEvent / ws.emitEvent)</li>
2530-
<li data-line="154" class="code-line" dir="auto"><a href="./extensions/admin/README.html"
2531-
data-href="./extensions/admin/README.html"><code>admin</code></a> — HTTP + WebSocket admin API, CSV/JSON
2526+
<li data-line="154" class="code-line" dir="auto"><a href="./extensions/admin/README.md"
2527+
data-href="./extensions/admin/README.md"><code>admin</code></a> — HTTP + WebSocket admin API, CSV/JSON
25322528
export, disconnect/latency endpoints, live dashboard</li>
2533-
<li data-line="155" class="code-line" dir="auto"><a href="./extensions/routing/README.html"
2534-
data-href="./extensions/routing/README.html"><code>routing</code></a> — targeted delivery (sendToUser,
2529+
<li data-line="155" class="code-line" dir="auto"><a href="./extensions/routing/README.md"
2530+
data-href="./extensions/routing/README.md"><code>routing</code></a> — targeted delivery (sendToUser,
25352531
sendToRole, sendToIp)</li>
2536-
<li data-line="156" class="code-line" dir="auto"><a href="./extensions/auth/README.html"
2537-
data-href="./extensions/auth/README.html"><code>auth</code></a> — authentication and role-based
2532+
<li data-line="156" class="code-line" dir="auto"><a href="./extensions/auth/README.md"
2533+
data-href="./extensions/auth/README.md"><code>auth</code></a> — authentication and role-based
25382534
authorization</li>
25392535
</ul>
25402536
<p data-line="158" class="code-line" dir="auto">If your project relies on a specific extension, tell me which one
@@ -2666,9 +2662,17 @@ <h2 data-line="282" class="code-line" dir="auto" id="-contributing--development"
26662662
<li data-line="284" class="code-line" dir="auto">If you need only the core to unblock dependent projects, use
26672663
the provided core export and tests. Extensions will follow; they are useful but not required for core
26682664
adoption.</li>
2669-
<li data-line="285" class="code-line" dir="auto">Tell me which extension to stabilise first
2670-
(<code>channels</code>, <code>history</code>, <code>events</code>, <code>auth</code>, <code>admin</code> or
2671-
<code>routing</code>) and I’ll prepare stable API docs, tests, and examples.</li>
2665+
<li data-line="285" class="code-line" dir="auto">Tell me which extension to stabilise first (<a
2666+
href="./extensions/channels/README.md"
2667+
data-href="./extensions/channels/README.md"><code>channels</code></a>, <a
2668+
href="./extensions/history/README.md"
2669+
data-href="./extensions/history/README.md"><code>history</code></a>, <a
2670+
href="./extensions/events/README.md" data-href="./extensions/events/README.md"><code>events</code></a>,
2671+
<a href="./extensions/auth/README.md" data-href="./extensions/auth/README.md"><code>auth</code></a>, <a
2672+
href="./extensions/admin/README.md" data-href="./extensions/admin/README.md"><code>admin</code></a> or
2673+
<a href="./extensions/routing/README.md"
2674+
data-href="./extensions/routing/README.md"><code>routing</code></a>) and I’ll prepare stable API docs,
2675+
tests, and examples.</li>
26722676
</ul>
26732677
<div data-line="287" class="code-line" dir="auto"></div>
26742678
<p align="right"><a href="#ws13-logo">Back to top ↑</a></p>

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# ws13 — WebSocket API v1.1.0
77

8-
Modular, extensible and operations-friendly WebSocket framework for Node.js. This release focuses on a small, stable core so dependent projects can proceed; extensions ([`channels`](./extensions/channels/README.html), [`auth`](./extensions/auth/README.html), [`history`](./extensions/history/README.html), [`events`](./extensions/events/README.html), [`admin`](./extensions/admin/README.html), [`routing`](./extensions/routing/README.html), [`heartbeat`](./extensions/heartbeat/README.html), [`message-meta`](./extensions/message-meta/README.html), `permessage-deflate`) exist as planned work and will be completed and documented in follow-up releases.
8+
Modular, extensible and operations-friendly WebSocket framework for Node.js. This release focuses on a small, stable core so dependent projects can proceed; extensions ([`channels`](./extensions/channels/README.md), [`auth`](./extensions/auth/README.md), [`history`](./extensions/history/README.md), [`events`](./extensions/events/README.md), [`admin`](./extensions/admin/README.md), [`routing`](./extensions/routing/README.md), [`heartbeat`](./extensions/heartbeat/README.md), [`message-meta`](./extensions/message-meta/README.md), `permessage-deflate`) exist as planned work and will be completed and documented in follow-up releases.
99

1010
Status: core stable and testable — extensions work in progress (APIs present in repository; integration examples available in examples/).
1111

@@ -33,7 +33,7 @@ Status: core stable and testable — extensions work in progress (APIs present i
3333
- TypeScript definitions included ('index.d.ts') for IDE support.
3434
- Tests included for core registry and basic behaviour (see 'index.test.js').
3535

36-
Extensions ([`channels`](./extensions/channels/README.html), [`events`](./extensions/events/README.html), [`history`](./extensions/history/README.html), [`admin`](./extensions/admin/README.html), [`routing`](./extensions/routing/README.html), [`message-meta`](./extensions/message-meta/README.html), [`heartbeat`](./extensions/heartbeat/README.html)) are available as separate modules in the repo but marked WIP — README below points to that.
36+
Extensions ([`channels`](./extensions/channels/README.md), [`events`](./extensions/events/README.md), [`history`](./extensions/history/README.md), [`admin`](./extensions/admin/README.md), [`routing`](./extensions/routing/README.md), [`message-meta`](./extensions/message-meta/README.md), [`heartbeat`](./extensions/heartbeat/README.md)) are available as separate modules in the repo but marked WIP — README below points to that.
3737

3838
<p align="right"><a href="#ws13-logo">Back to top ↑</a></p>
3939

@@ -147,14 +147,14 @@ Add more tests as needed; tests live next to core and in each extension folder w
147147
The following extensions exist as separate modules and will be fully documented and stabilised in subsequent releases.
148148
Current status: prototype/partial implementations present in repo.
149149

150-
- [`channels`](./extensions/channels/README.html) — channel-based pub/sub
151-
- [`message-meta`](./extensions/message-meta/README.html) — typed messages with meta (wrap/unwrap)
152-
- [`heartbeat`](./extensions/heartbeat/README.html) — idle/timeout hooks and monitor
153-
- [`history`](./extensions/history/README.html) — per-channel replay buffer (last N messages)
154-
- [`events`](./extensions/events/README.html) — JSON-RPC style event emitter (ws.onEvent / ws.emitEvent)
155-
- [`admin`](./extensions/admin/README.html) — HTTP + WebSocket admin API, CSV/JSON export, disconnect/latency endpoints, live dashboard
156-
- [`routing`](./extensions/routing/README.html) — targeted delivery (sendToUser, sendToRole, sendToIp)
157-
- [`auth`](./extensions/auth/README.html) — authentication and role-based authorization
150+
- [`channels`](./extensions/channels/README.md) — channel-based pub/sub
151+
- [`message-meta`](./extensions/message-meta/README.md) — typed messages with meta (wrap/unwrap)
152+
- [`heartbeat`](./extensions/heartbeat/README.md) — idle/timeout hooks and monitor
153+
- [`history`](./extensions/history/README.md) — per-channel replay buffer (last N messages)
154+
- [`events`](./extensions/events/README.md) — JSON-RPC style event emitter (ws.onEvent / ws.emitEvent)
155+
- [`admin`](./extensions/admin/README.md) — HTTP + WebSocket admin API, CSV/JSON export, disconnect/latency endpoints, live dashboard
156+
- [`routing`](./extensions/routing/README.md) — targeted delivery (sendToUser, sendToRole, sendToIp)
157+
- [`auth`](./extensions/auth/README.md) — authentication and role-based authorization
158158

159159
If your project relies on a specific extension, tell me which one and I will prioritise finishing it and publishing a stable interface.
160160

@@ -283,7 +283,7 @@ ws13/
283283
## 📌 Contributing & development
284284

285285
- If you need only the core to unblock dependent projects, use the provided core export and tests. Extensions will follow; they are useful but not required for core adoption.
286-
- Tell me which extension to stabilise first (`channels`, `history`, `events`, `auth`, `admin` or `routing`) and I’ll prepare stable API docs, tests, and examples.
286+
- Tell me which extension to stabilise first ([`channels`](./extensions/channels/README.md), [`history`](./extensions/history/README.md), [`events`](./extensions/events/README.md), [`auth`](./extensions/auth/README.md), [`admin`](./extensions/admin/README.md) or [`routing`](./extensions/routing/README.md)) and I’ll prepare stable API docs, tests, and examples.
287287

288288
<p align="right"><a href="#ws13-logo">Back to top ↑</a></p>
289289

0 commit comments

Comments
 (0)