@zerotal/broadcasting 1.8.1 → 1.10.0

package/CHANGELOG.md

@@ -8,6 +8,16 @@ follows the Zerotal monorepo's unified versioning.
 
 ## [Unreleased]
 
+## [1.9.0] — 2026-08-29
+
+### Documented
+
+- **Every promised export is documented.** The `docs-coverage` gate reads `maturity: stable` as a
+  promise about a package's exports, and measures how much of that promise is written down. It
+  was 798 gaps across the suite; it is now zero. This package's share is covered on its own
+  pages — types named, options shapes described, and the decisions behind them recorded where
+  somebody looking for them will find them.
+
 ## [1.5.0] — 2026-08-15
 
 ### Added

package/api-surface.md

@@ -198,11 +198,11 @@ function presenceChannel = (name: string) => string
 function privateChannel = (name: string) => string
 
 interface BroadcastConfigShape = {
-  channels?: string
+  channels?: string | undefined
   driver: 'null' | 'ws' | 'redis' | 'pusher'
   path: string
-  pusher?: {    appKey: string;    appSecret: string;}
-  redis?: {    url: string;}
+  pusher?: {    appKey: string;    appSecret: string;} | undefined
+  redis?: {    url: string;} | undefined
 }
 
 interface BroadcastEvent = {
@@ -218,10 +218,10 @@ interface BroadcastRecord = {
 }
 
 interface BroadcastsModelEventsOptions = {
-  as?: (modelName: string, event: ModelBroadcastEventName) => string
+  as?: ((modelName: string, event: ModelBroadcastEventName) => string) | undefined
   channels: (model: M, event: ModelBroadcastEventName) => string | string[]
-  events?: ModelBroadcastEventName[]
-  with?: (model: M, event: ModelBroadcastEventName) => object
+  events?: ModelBroadcastEventName[] | undefined
+  with?: ((model: M, event: ModelBroadcastEventName) => object) | undefined
 }
 
 interface PresenceMember = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerotal/broadcasting",
-  "version": "1.8.1",
+  "version": "1.10.0",
   "license": "MIT",
   "maturity": "stable",
   "private": false,
@@ -30,7 +30,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/core": "1.8.1"
+    "@zerotal/core": "1.10.0"
   },
   "devDependencies": {
     "typescript": "^5.8.0"

package/src/BroadcastsModelEvents.ts

@@ -6,13 +6,13 @@ export type ModelBroadcastEventName = "created" | "updated" | "deleted";
 
 export interface BroadcastsModelEventsOptions<M> {
   /** Which lifecycle events to broadcast. Default: `created`, `updated`, `deleted`. */
-  events?: ModelBroadcastEventName[];
+  events?: ModelBroadcastEventName[] | undefined;
   /** The channel(s) to broadcast on for a given model instance + event. */
   channels: (model: M, event: ModelBroadcastEventName) => string | string[];
   /** The wire event name. Default: `${ModelName}${Event}`, e.g. `OrderUpdated`. */
-  as?: (modelName: string, event: ModelBroadcastEventName) => string;
+  as?: ((modelName: string, event: ModelBroadcastEventName) => string) | undefined;
   /** The wire payload. Default: `{ [camelModelName]: model }`, e.g. `{ order }`. */
-  with?: (model: M, event: ModelBroadcastEventName) => object;
+  with?: ((model: M, event: ModelBroadcastEventName) => object) | undefined;
 }
 
 /** Minimal shape of an ORM model class with the `dispatchesEvents` bridge. */

package/src/config.ts

@@ -17,7 +17,7 @@ export interface BroadcastConfigShape {
    * @example
    * redis: { url: Bun.env.REDIS_URL ?? 'redis://localhost:6379' }
    */
-  redis?: { url: string };
+  redis?: { url: string } | undefined;
   /**
    * Pusher credentials - required when driver is `'pusher'`.
    * Configure a Pusher-compatible client to connect to ws://host/app/{appKey}.
@@ -27,10 +27,12 @@ export interface BroadcastConfigShape {
    *   appSecret: Bun.env.PUSHER_APP_SECRET!,
    * }
    */
-  pusher?: {
-    appKey: string;
-    appSecret: string;
-  };
+  pusher?:
+    | {
+        appKey: string;
+        appSecret: string;
+      }
+    | undefined;
   /**
    * Where the `Broadcast.channel(...)` authorization rules live, relative to the
    * project root (or absolute).
@@ -43,7 +45,7 @@ export interface BroadcastConfigShape {
    * @example
    * channels: "app/routes/channels.ts"
    */
-  channels?: string;
+  channels?: string | undefined;
 }
 
 const defaults: BroadcastConfigShape = {