stream-chat 9.37.0 → 9.38.0

package/dist/types/notifications/NotificationManager.d.ts

@@ -15,6 +15,8 @@ export declare class NotificationManager {
     addWarning({ message, origin, options }: AddNotificationPayload): string;
     addInfo({ message, origin, options }: AddNotificationPayload): string;
     addSuccess({ message, origin, options }: AddNotificationPayload): string;
+    clearTimeout(id: string): void;
+    startTimeout(id: string, durationOverride?: number): void;
     remove(id: string): void;
     clear(): void;
 }

package/dist/types/notifications/types.d.ts

@@ -19,8 +19,6 @@ export type Notification = {
     id: string;
     /** The notification message text */
     message: string;
-    /** The severity level of the notification */
-    severity: NotificationSeverity;
     /** Timestamp when notification was created */
     createdAt: number;
     /**
@@ -30,6 +28,8 @@ export type Notification = {
     origin: NotificationOrigin;
     /** Array of action buttons for the notification */
     actions?: NotificationAction[];
+    /** The severity level of the notification. Defaults to undefined unless explicitly provided. */
+    severity?: NotificationSeverity;
     /**
      * Optional code that can be used to group the notifications of the same type, e.g. attachment-upload-blocked.
      * Format: domain:entity:operation:result
@@ -74,16 +74,21 @@ export type Notification = {
      *   'system:resource:unavailable';     // System resource unavailable
      */
     type?: string;
-    /** Optional timestamp when notification should expire */
-    expiresAt?: number;
+    /** Optional auto-dismiss duration in milliseconds. The timeout starts when NotificationManager.startTimeout() is called. */
+    duration?: number;
     /** Optional metadata to attach to the notification */
     metadata?: Record<string, unknown>;
+    /** Optional tags that can be used for routing or grouping notifications (e.g. `target:channel`). */
+    tags?: string[];
     /** In case of error notification the instance of the originally thrown error */
     originalError?: Error;
 };
 /** Configuration options when creating a notification */
-export type NotificationOptions = Partial<Pick<Notification, 'type' | 'severity' | 'actions' | 'metadata' | 'originalError'>> & {
-    /** How long a notification should be displayed in milliseconds */
+export type NotificationOptions = Partial<Pick<Notification, 'type' | 'severity' | 'actions' | 'metadata' | 'tags' | 'originalError'>> & {
+    /**
+     * How long a notification should be displayed in milliseconds.
+     * Use `0` for persistent (no auto-dismiss); call `client.notifications.remove(id)` to dismiss.
+     */
     duration?: number;
 };
 /**
@@ -96,8 +101,10 @@ export type NotificationState = {
 };
 /** State shape for the notification store */
 export type NotificationManagerState = NotificationState;
+export type NotificationSortComparator = (a: Notification, b: Notification) => number;
 export type NotificationManagerConfig = {
-    durations: Record<NotificationSeverity, number>;
+    durations: Partial<Record<NotificationSeverity, number>>;
+    sortComparator?: NotificationSortComparator;
 };
 export type AddNotificationPayload = Pick<Notification, 'message' | 'origin'> & {
     options?: NotificationOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat",
-  "version": "9.37.0",
+  "version": "9.38.0",
   "description": "JS SDK for the Stream Chat API",
   "homepage": "https://getstream.io/chat/",
   "author": {

package/src/notifications/NotificationManager.ts

@@ -42,8 +42,9 @@ export class NotificationManager {
   add({ message, origin, options = {} }: AddNotificationPayload): string {
     const id = generateUUIDv4();
     const now = Date.now();
-    const severity = options.severity || 'info';
-    const duration = options.duration ?? this.config.durations[severity];
+    const severity = options.severity;
+    const duration =
+      options.duration ?? (severity ? this.config.durations[severity] : undefined);
 
     const notification: Notification = {
       id,
@@ -52,24 +53,21 @@ export class NotificationManager {
       type: options?.type,
       severity,
       createdAt: now,
-      expiresAt: now + duration,
+      duration,
       actions: options.actions,
       metadata: options.metadata,
+      tags: options.tags,
       originalError: options.originalError,
     };
 
+    const notifications = [...this.store.getLatestValue().notifications, notification];
+
     this.store.partialNext({
-      notifications: [...this.store.getLatestValue().notifications, notification],
+      notifications: this.config.sortComparator
+        ? [...notifications].sort(this.config.sortComparator)
+        : notifications,
     });
 
-    if (notification.expiresAt) {
-      const timeout = setTimeout(() => {
-        this.remove(id);
-      }, options.duration || this.config.durations[notification.severity]);
-
-      this.timeouts.set(id, timeout);
-    }
-
     return id;
   }
 
@@ -89,12 +87,34 @@ export class NotificationManager {
     return this.add({ message, origin, options: { ...options, severity: 'success' } });
   }
 
-  remove(id: string): void {
+  clearTimeout(id: string): void {
     const timeout = this.timeouts.get(id);
-    if (timeout) {
-      clearTimeout(timeout);
-      this.timeouts.delete(id);
-    }
+
+    if (!timeout) return;
+
+    clearTimeout(timeout);
+    this.timeouts.delete(id);
+  }
+
+  startTimeout(id: string, durationOverride?: number): void {
+    const notification = this.store
+      .getLatestValue()
+      .notifications.find((n) => n.id === id);
+    const duration = durationOverride ?? notification?.duration;
+
+    if (!notification || !duration) return;
+
+    this.clearTimeout(id);
+
+    const timeout = setTimeout(() => {
+      this.remove(id);
+    }, duration);
+
+    this.timeouts.set(id, timeout);
+  }
+
+  remove(id: string): void {
+    this.clearTimeout(id);
 
     this.store.partialNext({
       notifications: this.store.getLatestValue().notifications.filter((n) => n.id !== id),

package/src/notifications/types.ts

@@ -24,8 +24,6 @@ export type Notification = {
   id: string;
   /** The notification message text */
   message: string;
-  /** The severity level of the notification */
-  severity: NotificationSeverity;
   /** Timestamp when notification was created */
   createdAt: number;
   /**
@@ -35,6 +33,8 @@ export type Notification = {
   origin: NotificationOrigin;
   /** Array of action buttons for the notification */
   actions?: NotificationAction[];
+  /** The severity level of the notification. Defaults to undefined unless explicitly provided. */
+  severity?: NotificationSeverity;
   /**
    * Optional code that can be used to group the notifications of the same type, e.g. attachment-upload-blocked.
    * Format: domain:entity:operation:result
@@ -79,19 +79,27 @@ export type Notification = {
    *   'system:resource:unavailable';     // System resource unavailable
    */
   type?: string;
-  /** Optional timestamp when notification should expire */
-  expiresAt?: number;
+  /** Optional auto-dismiss duration in milliseconds. The timeout starts when NotificationManager.startTimeout() is called. */
+  duration?: number;
   /** Optional metadata to attach to the notification */
   metadata?: Record<string, unknown>;
+  /** Optional tags that can be used for routing or grouping notifications (e.g. `target:channel`). */
+  tags?: string[];
   /** In case of error notification the instance of the originally thrown error */
   originalError?: Error;
 };
 
 /** Configuration options when creating a notification */
 export type NotificationOptions = Partial<
-  Pick<Notification, 'type' | 'severity' | 'actions' | 'metadata' | 'originalError'>
+  Pick<
+    Notification,
+    'type' | 'severity' | 'actions' | 'metadata' | 'tags' | 'originalError'
+  >
 > & {
-  /** How long a notification should be displayed in milliseconds */
+  /**
+   * How long a notification should be displayed in milliseconds.
+   * Use `0` for persistent (no auto-dismiss); call `client.notifications.remove(id)` to dismiss.
+   */
   duration?: number;
 };
 
@@ -107,8 +115,11 @@ export type NotificationState = {
 /** State shape for the notification store */
 export type NotificationManagerState = NotificationState;
 
+export type NotificationSortComparator = (a: Notification, b: Notification) => number;
+
 export type NotificationManagerConfig = {
-  durations: Record<NotificationSeverity, number>;
+  durations: Partial<Record<NotificationSeverity, number>>;
+  sortComparator?: NotificationSortComparator;
 };
 
 export type AddNotificationPayload = Pick<Notification, 'message' | 'origin'> & {