@nolag/chat 0.1.2 → 0.2.0

package/dist/types.d.ts

@@ -56,8 +56,12 @@ export interface ChatMessage {
     data?: Record<string, unknown>;
     /** Timestamp (ms since epoch) */
     timestamp: number;
-    /** Delivery status */
-    status: 'sending' | 'sent' | 'delivered';
+    /**
+     * Delivery status. `streaming` = an in-progress streamed message whose `text`
+     * is still growing; it becomes `delivered`/`sent` when finalized, or `aborted`
+     * if the stream was cancelled.
+     */
+    status: 'sending' | 'sent' | 'delivered' | 'streaming' | 'aborted';
     /** Whether this message came from replay (history) */
     isReplay: boolean;
 }
@@ -65,6 +69,31 @@ export interface SendMessageOptions {
     /** Optional structured data to attach */
     data?: Record<string, unknown>;
 }
+export interface StreamMessageOptions {
+    /** Optional structured data to attach to the final message */
+    data?: Record<string, unknown>;
+    /**
+     * Coalesce appended tokens and publish a network delta at most this often (ms).
+     * Lower = smoother but more messages; higher = fewer/larger chunks.
+     * Default 60. The local message text updates immediately regardless.
+     */
+    flushIntervalMs?: number;
+}
+/**
+ * Handle for an in-progress outgoing streamed message — e.g. an AI response
+ * generated token-by-token. Append tokens as they arrive, then `complete()` to
+ * finalize + persist, or `abort()` to cancel.
+ */
+export interface MessageStream {
+    /** The optimistic streaming message; its `text` grows as you append. */
+    readonly message: ChatMessage;
+    /** Append a token/chunk; updates the message and (throttled) broadcasts a delta. */
+    append(text: string): void;
+    /** Finalize: flush, publish the persisted message, emit `streamEnd`. Returns the message. */
+    complete(): ChatMessage;
+    /** Cancel the stream; broadcasts an abort and does NOT persist a message. */
+    abort(error?: string): void;
+}
 export interface ChatClientEvents {
     connected: [];
     disconnected: [reason: string];
@@ -92,6 +121,20 @@ export interface ChatRoomEvents {
         room: string;
         count: number;
     }];
+    /** A streamed message started (placeholder, status 'streaming') */
+    streamStart: [message: ChatMessage];
+    /** A streamed message grew by `delta` (message.text already updated) */
+    streamChunk: [data: {
+        message: ChatMessage;
+        delta: string;
+    }];
+    /** A streamed message finished (status 'delivered'/'sent', final text) */
+    streamEnd: [message: ChatMessage];
+    /** A streamed message was cancelled (status 'aborted') */
+    streamAbort: [data: {
+        message: ChatMessage;
+        error?: string;
+    }];
 }
 /** Shape of data stored in NoLag presence for chat users */
 export interface ChatPresenceData {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nolag/chat",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "type": "module",
   "engines": {
     "node": ">=18.0.0"
@@ -46,10 +46,10 @@
   "license": "MIT",
   "homepage": "https://nolag.app",
   "devDependencies": {
-    "@nolag/js-sdk": "^1.8.0"
+    "@nolag/js-sdk": "^1.9.0"
   },
   "peerDependencies": {
-    "@nolag/js-sdk": "^1.8.0"
+    "@nolag/js-sdk": "^1.9.0"
   },
   "publishConfig": {
     "access": "public"