@stacksjs/realtime 0.75.236 → 0.75.238

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type { BroadcastStreamOptions } from './stream';
+export type { BroadcastStreamMetadata, BroadcastStreamOptions } from './stream';
 export type { EmitOptions } from './emit';
 export type { BroadcastInstance } from './broadcast';
 export type { BufferedMessage, ReplayBufferConfig } from './replay-buffer';

package/dist/stream.d.ts

@@ -1,9 +1,16 @@
 /** Authenticated SSE transport for the same engine used by emit(), channels and model broadcasts. */
 export declare function createBroadcastResponse(options: BroadcastStreamOptions): Promise<Response>;
+export declare interface BroadcastStreamMetadata {
+  readonly channel: string
+  readonly event: string
+  readonly data: unknown
+}
 export declare interface BroadcastStreamOptions {
   channels: readonly string[]
   authorize: () => boolean | Promise<boolean>
   signal?: AbortSignal
   heartbeatMs?: number
   maxPending?: number
+  onEnqueue?: (chunk: Uint8Array, broadcast: BroadcastStreamMetadata | null) => void
+  onClose?: () => void
 }

package/dist/stream.js

@@ -1,7 +1,7 @@
-import{AsyncResource}from"node:async_hooks";import{getServer}from"./server-instance";export async function createBroadcastResponse(options){if(!options.channels.length||typeof options.authorize!=="function")throw Error("Broadcast streams require channels and authorization");const authorize=AsyncResource.bind(options.authorize,void 0,options);if(!await authorize())return new Response("Unauthorized",{status:401});const server=getServer();if(!server)throw Error("Broadcast server not initialized");const channels=new Set(options.channels),encoder=new TextEncoder,maxPending=options.maxPending??64;if(!Number.isSafeInteger(maxPending)||maxPending<1||maxPending>1024||options.heartbeatMs!==void 0&&(!Number.isFinite(options.heartbeatMs)||options.heartbeatMs<1))throw Error("Invalid broadcast stream configuration");let cleanup=()=>{};const stream=new ReadableStream({start(controller){let closed=!1,pending=0,chain=Promise.resolve(),timer,remove=()=>{};function close(){if(closed)return;closed=!0;remove();clearInterval(timer);options.signal?.removeEventListener("abort",close);try{controller.close()}catch{}}function enqueue(frame){if(closed)return;if((controller.desiredSize??0)<=0){close();return}controller.enqueue(encoder.encode(frame))}function deliver(frame){if(closed)return;if(++pending>maxPending){close();return}chain=chain.then(async()=>{if(closed)return;if(!await authorize()){close();return}enqueue(frame)}).catch(close).finally(()=>{pending--})}cleanup=close;remove=server.addBroadcastHook(({channel,event,data})=>{if(channels.has(channel))deliver(`data: ${JSON.stringify({channel,event,data})}
+import{AsyncResource}from"node:async_hooks";import{getServer}from"./server-instance";export async function createBroadcastResponse(options){if(!options.channels.length||typeof options.authorize!=="function")throw Error("Broadcast streams require channels and authorization");const authorize=AsyncResource.bind(options.authorize,void 0,options),enqueueObserver=options.onEnqueue?AsyncResource.bind(options.onEnqueue,void 0,options):void 0,closeObserver=options.onClose?AsyncResource.bind(options.onClose,void 0,options):void 0;if(!await authorize())return new Response("Unauthorized",{status:401});const server=getServer();if(!server)throw Error("Broadcast server not initialized");const channels=new Set(options.channels),encoder=new TextEncoder,maxPending=options.maxPending??64;if(!Number.isSafeInteger(maxPending)||maxPending<1||maxPending>1024||options.heartbeatMs!==void 0&&(!Number.isFinite(options.heartbeatMs)||options.heartbeatMs<1))throw Error("Invalid broadcast stream configuration");let cleanup=()=>{};const stream=new ReadableStream({start(controller){let closed=!1,pending=0,chain=Promise.resolve(),timer,remove=()=>{};function close(){if(closed)return;closed=!0;remove();clearInterval(timer);options.signal?.removeEventListener("abort",close);try{controller.close()}catch{}try{const result=closeObserver?.();if(result!==void 0)Promise.resolve(result).catch(()=>{})}catch{}}function enqueue(frame,broadcast=null){if(closed)return;if((controller.desiredSize??0)<=0){close();return}const chunk=encoder.encode(frame);controller.enqueue(chunk);try{const result=enqueueObserver?.(chunk,broadcast);if(result!==void 0)Promise.resolve(result).catch(close)}catch{close()}}function deliver(frame,broadcast=null){if(closed)return;if(++pending>maxPending){close();return}chain=chain.then(async()=>{if(closed)return;if(!await authorize()){close();return}enqueue(frame,broadcast)}).catch(close).finally(()=>{pending--})}cleanup=close;remove=server.addBroadcastHook(({channel,event,data})=>{if(channels.has(channel))deliver(`data: ${JSON.stringify({channel,event,data})}
 
-`)});enqueue(`: connected
+`,{channel,event,data})});enqueue(`: connected
 
-`);timer=setInterval(()=>deliver(`: heartbeat
+`);if(!closed){timer=setInterval(()=>deliver(`: heartbeat
 
-`),options.heartbeatMs??15000);options.signal?.addEventListener("abort",close,{once:!0});if(options.signal?.aborted)close()},cancel(){cleanup()}},{highWaterMark:maxPending});return new Response(stream,{headers:{"Content-Type":"text/event-stream","Cache-Control":"no-store","X-Accel-Buffering":"no"}})}
+`),options.heartbeatMs??15000);options.signal?.addEventListener("abort",close,{once:!0});if(options.signal?.aborted)close()}},cancel(){cleanup()}},{highWaterMark:maxPending});return new Response(stream,{headers:{"Content-Type":"text/event-stream","Cache-Control":"no-store","X-Accel-Buffering":"no"}})}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/realtime",
   "type": "module",
   "sideEffects": false,
-  "version": "0.75.236",
+  "version": "0.75.238",
   "description": "The Stacks realtime integration. Built on top of ts-broadcasting.",
   "author": "Chris Breuer",
   "contributors": [
@@ -58,8 +58,8 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/logging": "0.75.236",
-    "@stacksjs/path": "0.75.236",
+    "@stacksjs/logging": "0.75.238",
+    "@stacksjs/path": "0.75.238",
     "ts-broadcasting": "^0.0.11"
   },
   "devDependencies": {