@zerotal/broadcasting 1.3.0 → 1.5.0

package/CHANGELOG.md

@@ -4,10 +4,41 @@ All notable changes to this package are documented here. The format is
 based on [Keep a Changelog](https://keepachangelog.com/); this package
 follows the Zerotal monorepo's unified versioning.
 
-**Maturity: `beta`**
+**Maturity: `stable`**
 
 ## [Unreleased]
 
+## [1.5.0] — 2026-08-15
+
+### Added
+
+- **Tests for `currentSocketId`** — the one function deciding whether a broadcast
+  excludes the connection that caused it. Both failure modes present as UI bugs
+  rather than broadcasting ones: returning nothing when a header _was_ sent makes
+  `toOthers()` exclude nobody, so the user who just made an optimistic update gets
+  their own event back and double-applies it; returning something outside a request
+  makes a queue job silently exclude an unrelated connection. Case-insensitive
+  header matching is pinned too, since Echo sends `X-Socket-ID` and hand-rolled
+  clients send it lowercase. 143 tests → 148.
+
+- **`PendingBroadcast`, `RedisBroadcastDriver` and `PusherCompatManager` are
+  documented.** The driver table now names the class behind each `driver` key, and
+  the events guide explains why `broadcast(event)` needs no `.send()` — it returns a
+  thenable that dispatches on the next microtask, which is what lets `.toOthers()`
+  configure it first.
+
+### Changed
+
+- **Four exports are marked `@internal`** and leave the compatibility promise:
+  `ChannelRegistry`, `channelRegistry`, `compileChannelPattern` and `broadcastOnce`
+  — pattern plumbing and process-wide wiring, the last of which says in its own
+  docblock that it is "exported for the hook". The promise is 20 exports, not 24.
+
+- **Maturity is now `stable`** — the public API follows SemVer strictly for the rest
+  of the 1.x line. Every promised export is documented, the package has six guide
+  pages and the deepest behavioural coverage of its peer group, and its only
+  dependency is `@zerotal/core`.
+
 ## [1.0.3] — 2026-08-07
 
 ### Changed

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@zerotal/broadcasting",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "license": "MIT",
-  "maturity": "beta",
+  "maturity": "stable",
   "private": false,
   "type": "module",
   "main": "./src/index.ts",
@@ -29,7 +29,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/core": "1.3.0"
+    "@zerotal/core": "1.5.0"
   },
   "devDependencies": {
     "typescript": "^5.8.0"

package/src/BroadcastingEvent.ts

@@ -8,6 +8,8 @@ const _broadcasted = new WeakSet<object>();
 /**
  * Broadcast an event at most once (idempotent across `dispatch()` and the `Events` auto-broadcast
  * hook), gated by `broadcastWhen()` (default true). Used by both paths; exported for the hook.
+ *
+ * @internal
  */
 export function broadcastOnce(event: BroadcastEvent): void {
   if (_broadcasted.has(event)) return;

package/src/ChannelRegistry.ts

@@ -42,7 +42,10 @@ function escapeRegex(s: string): string {
   return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 
-/** Compile a `[param]` pattern into a regex + ordered param names. */
+/** Compile a `[param]` pattern into a regex + ordered param names.
+ *
+ * @internal
+ */
 export function compileChannelPattern(pattern: string): { regex: RegExp; paramNames: string[] } {
   const paramNames: string[] = [];
   let regexStr = "^";
@@ -64,6 +67,7 @@ export type AuthorizeResult =
   | { matched: false } // no registered pattern claims this channel
   | { matched: true; result: boolean | PresenceMemberData | null | undefined };
 
+/** @internal */
 export class ChannelRegistry {
   private _channels: CompiledChannel[] = [];
 
@@ -108,5 +112,8 @@ export class ChannelRegistry {
   }
 }
 
-/** Process-wide registry shared by the `Broadcast` facade and `BroadcastProvider`. */
+/** Process-wide registry shared by the `Broadcast` facade and `BroadcastProvider`.
+ *
+ * @internal
+ */
 export const channelRegistry = new ChannelRegistry();