@streamlayer/sdk-web-notifications 0.14.2 → 0.15.1

package/lib/index.d.ts

@@ -10,6 +10,7 @@ declare module '@streamlayer/sdk-web-interfaces' {
     }
     interface StreamLayerSDK {
         getNotificationsStore: Notifications['getQueueStore'];
+        getActiveNotification: Notifications['getActiveNotification'];
     }
 }
 /**

package/lib/index.js

@@ -4,8 +4,14 @@ export { NotificationType, Notifications } from './notifications';
  * notifications plugin, connect notifications to sdk
  */
 export const notifications = (instance, opts, done) => {
-    instance.notifications = new Notifications();
+    instance.notifications = new Notifications(undefined);
     instance.addNotification = instance.notifications.add;
     instance.sdk.getNotificationsStore = () => instance.notifications.getQueueStore();
+    instance.sdk.getActiveNotification = () => instance.notifications.getActiveNotification();
+    instance.sdk.onMount(() => {
+        return () => {
+            instance.notifications.queue.drain();
+        };
+    });
     done();
 };

package/lib/notifications.d.ts

@@ -1,6 +1,7 @@
 import { InstantView, QuestionType, GameSettings, TweetHistory } from '@streamlayer/sdk-web-types';
 import { NotificationsQueue, NotificationsQueueOptions } from './queue';
 export type NotificationData = {
+    questionId: string;
     questionType: QuestionType;
     question?: {
         title: string;
@@ -40,6 +41,7 @@ export type Notification<M extends Record<string, Function> = never> = {
     action?: (...args: unknown[]) => void;
     close?: (...args: unknown[]) => void;
     methods?: M;
+    emitEvent?: boolean;
     data: NotificationData;
     id: string;
     persistent?: boolean;
@@ -53,6 +55,7 @@ export declare class Notifications {
     constructor(options?: Partial<NotificationsQueueOptions>);
     add: (notification: Notification) => void;
     close: (notificationId: string, markAsViewed?: boolean) => void;
+    getActiveNotification: () => Notification | null;
     getQueueStore: () => import("nanostores").WritableAtom<Map<string, Notification> | undefined>;
     markAsViewed: (notificationId: string) => void;
 }

package/lib/notifications.js

@@ -1,3 +1,4 @@
+import { eventBus } from '@streamlayer/sdk-web-interfaces';
 import { NotificationsQueue } from './queue';
 import { NotificationStorage } from './storage';
 export var NotificationType;
@@ -19,6 +20,21 @@ export class Notifications {
     add = (notification) => {
         const isViewed = this.storage.isOpened(notification.id);
         if (!isViewed) {
+            if (notification.data && notification.emitEvent) {
+                const action = notification.action;
+                notification.action = (...args) => {
+                    if (action) {
+                        action(...args);
+                    }
+                    eventBus.emit('notification', {
+                        action: 'opened',
+                        payload: {
+                            questionId: notification.data.questionId,
+                            questionType: notification.data.questionType,
+                        },
+                    });
+                };
+            }
             this.queue.addToQueue(notification);
         }
     };
@@ -28,6 +44,19 @@ export class Notifications {
             this.markAsViewed(notificationId);
         }
     };
+    getActiveNotification = () => {
+        const notifications = this.queue.notificationsList.get();
+        if (!notifications?.size) {
+            return null;
+        }
+        for (const notification of notifications.values()) {
+            if (notification.type === NotificationType.ONBOARDING) {
+                return notification;
+            }
+        }
+        const notification = notifications.values().next().value;
+        return notification;
+    };
     getQueueStore = () => {
         return this.queue.notificationsList;
     };

package/lib/queue/index.d.ts

@@ -7,7 +7,6 @@ export type NotificationsQueueOptions = {
 export type NotificationsList = ReturnType<typeof createComputedStore<Notification[]>>;
 export declare class NotificationsQueue {
     notificationsList: ReturnType<SingleStore<Map<Notification['id'], Notification>>['getStore']>;
-    private notifications;
     private store;
     private timeouts;
     private waitingQueue;
@@ -18,5 +17,6 @@ export declare class NotificationsQueue {
     addToQueue: (notification: Notification) => void;
     tickWaitingQueue: () => void;
     tickActiveQueue: (notificationId: string) => void;
-    closeNotification: (notificationId: string) => void;
+    closeNotification: (notificationId: string) => Notification | undefined;
+    drain: () => void;
 }

package/lib/queue/index.js

@@ -1,8 +1,7 @@
-import { SingleStore, createSingleStore } from '@streamlayer/sdk-web-interfaces';
+import { createSingleStore } from '@streamlayer/sdk-web-interfaces';
 import { createLogger } from '@streamlayer/sdk-web-logger';
 export class NotificationsQueue {
     notificationsList;
-    notifications;
     store;
     timeouts;
     waitingQueue;
@@ -16,8 +15,7 @@ export class NotificationsQueue {
         this.timeouts = new Map();
         this.waitingQueue = new Set();
         this.activeQueue = new Set();
-        this.notifications = new SingleStore(createSingleStore(new Map()), 'notifications-queue');
-        this.notificationsList = this.notifications.getStore();
+        this.notificationsList = createSingleStore(new Map());
     }
     addToQueue = (notification) => {
         if (this.store.has(notification.id)) {
@@ -90,9 +88,9 @@ export class NotificationsQueue {
         }
         const timeout = setTimeout(() => {
             const closureId = notificationId;
-            const prevQueue = new Map(this.notifications.getValue());
+            const prevQueue = new Map(this.notificationsList.get());
             prevQueue.set(notification.id, notification);
-            this.notifications.setValue(prevQueue);
+            this.notificationsList.set(prevQueue);
             const timeout = setTimeout(() => {
                 this.logger.debug({ notificationId: closureId, delay: notification.autoHideDuration || 5000 }, 'notification hiding by autoHideDuration');
                 this.closeNotification(closureId);
@@ -105,17 +103,17 @@ export class NotificationsQueue {
         this.tickWaitingQueue();
     };
     closeNotification = (notificationId) => {
-        const prevQueue = new Map(this.notifications.getValue());
+        const prevQueue = new Map(this.notificationsList.get());
         const notification = prevQueue.get(notificationId);
         if (notification) {
             // do not hide notification if we have more than one notification in waiting queue,
             // because we need to show next notification immediately
             notification.hiding = !(this.waitingQueue.size >= this.options.concurrency);
-            this.notifications.setValue(prevQueue);
+            this.notificationsList.set(prevQueue);
             const timeout = setTimeout(() => {
-                const prevQueue = new Map(this.notifications.getValue());
+                const prevQueue = new Map(this.notificationsList.get());
                 prevQueue.delete(notificationId);
-                this.notifications.setValue(prevQueue);
+                this.notificationsList.set(prevQueue);
                 const timeout = this.timeouts.get(notificationId);
                 if (timeout !== undefined) {
                     clearTimeout(timeout);
@@ -130,5 +128,14 @@ export class NotificationsQueue {
         this.waitingQueue.delete(notificationId);
         this.tickWaitingQueue();
         this.logger.debug({ notificationId }, 'notification hiding');
+        return notification;
+    };
+    drain = () => {
+        this.store.clear();
+        this.timeouts.clear();
+        this.waitingQueue.clear();
+        this.activeQueue.clear();
+        this.notificationsList.off();
+        this.notificationsList.set(new Map());
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamlayer/sdk-web-notifications",
-  "version": "0.14.2",
+  "version": "0.15.1",
   "type": "module",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -9,10 +9,10 @@
     "package.json"
   ],
   "peerDependencies": {
-    "@streamlayer/sdk-web-interfaces": "^0.20.6",
-    "@streamlayer/sdk-web-logger": "^0.5.17",
-    "@streamlayer/sdk-web-types": "^0.22.4",
-    "@streamlayer/sdk-web-storage": "^0.4.4"
+    "@streamlayer/sdk-web-interfaces": "^0.21.0",
+    "@streamlayer/sdk-web-logger": "^0.5.18",
+    "@streamlayer/sdk-web-storage": "^0.4.5",
+    "@streamlayer/sdk-web-types": "^0.23.0"
   },
   "exports": {
     ".": {
@@ -22,8 +22,8 @@
     }
   },
   "devDependencies": {
-    "@nx/playwright": "^17.3.0",
-    "@nx/webpack": "^17.3.0",
+    "@nx/playwright": "17.3.0",
+    "@nx/webpack": "17.3.0",
     "@playwright/test": "^1.41.1",
     "tslib": "^2.6.2",
     "webpack": "^5.90.0"