Merge pull request #1532 from SuperFlyTV/feat/add-notifications-to-lsg

feat: add notifications to lsg

Author: justandras

meteor/server/publications/system.ts

@@ -5,6 +5,7 @@ import { RundownId, RundownPlaylistId, StudioId } from '@sofie-automation/coreli
 import { check } from 'meteor/check'
 import { SYSTEM_ID } from '@sofie-automation/meteor-lib/dist/collections/CoreSystem'
 import { triggerWriteAccessBecauseNoCheckNecessary } from '../security/securityVerify'
+import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 
 meteorPublish(MeteorPubSub.coreSystem, async function (_token: string | undefined) {
 	triggerWriteAccessBecauseNoCheckNecessary()
@@ -26,7 +27,7 @@ meteorPublish(MeteorPubSub.coreSystem, async function (_token: string | undefine
 	})
 })
 
-meteorPublish(MeteorPubSub.notificationsForRundown, async function (studioId: StudioId, rundownId: RundownId) {
+meteorPublish(CorelibPubSub.notificationsForRundown, async function (studioId: StudioId, rundownId: RundownId) {
 	// HACK: This should do real auth
 	triggerWriteAccessBecauseNoCheckNecessary()
 
@@ -41,7 +42,7 @@ meteorPublish(MeteorPubSub.notificationsForRundown, async function (studioId: St
 })
 
 meteorPublish(
-	MeteorPubSub.notificationsForRundownPlaylist,
+	CorelibPubSub.notificationsForRundownPlaylist,
 	async function (studioId: StudioId, playlistId: RundownPlaylistId) {
 		// HACK: This should do real auth
 		triggerWriteAccessBecauseNoCheckNecessary()

packages/corelib/src/pubsub.ts

@@ -38,6 +38,7 @@ import { BlueprintId, BucketId, RundownPlaylistActivationId, SegmentId, ShowStyl
 import { PackageInfoDB } from './dataModel/PackageInfos.js'
 import { UIPieceContentStatus } from './dataModel/PieceContentStatus.js'
 import { Bucket } from './dataModel/Bucket.js'
+import { DBNotificationObj } from './dataModel/Notifications.js'
 
 /**
  * Ids of possible DDP subscriptions for any the UI and gateways accessing the Rundown & RundownPlaylist model.
@@ -130,6 +131,14 @@ export enum CorelibPubSub {
 	 * Fetch all Expected Package statuses in the specified Studios
 	 */
 	expectedPackageWorkStatuses = 'expectedPackageWorkStatuses',
+	/**
+	 * Fetch notifications for playlist
+	 */
+	notificationsForRundownPlaylist = 'notificationsForRundownPlaylist',
+	/**
+	 * Fetch notifications for rundown
+	 */
+	notificationsForRundown = 'notificationsForRundown',
 	/**
 	 * Fetch all Package container statuses in the specified Studios
 	 */
@@ -328,6 +337,11 @@ export interface CorelibPubSubTypes {
 		studioIds: StudioId[],
 		token?: string
 	) => CollectionName.PackageContainerStatuses
+	[CorelibPubSub.notificationsForRundown]: (studioId: StudioId, rundownId: RundownId) => CollectionName.Notifications
+	[CorelibPubSub.notificationsForRundownPlaylist]: (
+		studioId: StudioId,
+		playlistId: RundownPlaylistId
+	) => CollectionName.Notifications
 	[CorelibPubSub.packageInfos]: (deviceId: PeripheralDeviceId, token?: string) => CollectionName.PackageInfos
 
 	[CorelibPubSub.uiPieceContentStatuses]: (
@@ -345,6 +359,7 @@ export type CorelibPubSubCollections = {
 	[CollectionName.ExpectedPackages]: ExpectedPackageDBBase
 	[CollectionName.ExpectedPackageWorkStatuses]: ExpectedPackageWorkStatus
 	[CollectionName.ExternalMessageQueue]: ExternalMessageQueueObj
+	[CollectionName.Notifications]: DBNotificationObj
 	[CollectionName.NrcsIngestDataCache]: NrcsIngestDataCacheObj
 	[CollectionName.PartInstances]: DBPartInstance
 	[CollectionName.PackageContainerStatuses]: PackageContainerStatusDB

packages/live-status-gateway-api/api/asyncapi.yaml

@@ -47,3 +47,5 @@ channels:
     $ref: './topics/packages/packagesTopic.yaml'
   buckets:
     $ref: './topics/buckets/bucketsTopic.yaml'
+  notifications:
+    $ref: './topics/notifications/notificationsTopic.yaml'

packages/live-status-gateway-api/api/components/notifications/events/notificationsEvent/notificationsEvent-example.yaml

@@ -0,0 +1,3 @@
+event: notifications
+activeNotifications:
+  - $ref: '../../notificationObj/notificationObj-example.yaml'

packages/live-status-gateway-api/api/components/notifications/events/notificationsEvent/notificationsEvent.yaml

@@ -0,0 +1,18 @@
+$defs:
+  notificationsEvent:
+    type: object
+    title: NotificationsEvent
+    description: Active notifications in Sofie
+    properties:
+      event:
+        type: string
+        const: notifications
+      activeNotifications:
+        description: Active notifications in Sofie
+        type: array
+        items:
+          $ref: '../../notificationObj/notificationObj.yaml#/$defs/NotificationObj'
+    required: [event, activeNotifications]
+    additionalProperties: false
+    examples:
+      - $ref: './notificationsEvent-example.yaml'

packages/live-status-gateway-api/api/components/notifications/messages/notificationsMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    notificationsMessage:
+      messageId: notificationsUpdate
+      title: Active notifications in Sofie
+      payload:
+        $ref: '../events/notificationsEvent/notificationsEvent.yaml#/$defs/notificationsEvent'
+      examples:
+        - payload:
+            $ref: '../events/notificationsEvent/notificationsEvent-example.yaml'

packages/live-status-gateway-api/api/components/notifications/notificationObj/notificationObj-example.yaml

@@ -0,0 +1,7 @@
+_id: 'notif123'
+severity: error
+message: 'disk.space.low'
+relatedTo:
+  $ref: '../target/pieceInstance/notificationTargetPieceInstance-example.yaml'
+created: 1694784932
+modified: 1694784950

packages/live-status-gateway-api/api/components/notifications/notificationObj/notificationObj.yaml

@@ -0,0 +1,33 @@
+$defs:
+  NotificationObj:
+    type: object
+    title: NotificationObj
+    description: This describes a notification that should be shown to a user. These can come from various sources, and are added and removed dynamically during system usage
+    required:
+      - _id
+      - severity
+      - message
+      - relatedTo
+      - created
+    properties:
+      _id:
+        type: string
+        description: Unique identifier for the notification
+      severity:
+        $ref: '../notificationSeverity.yaml#/$defs/severity'
+      message:
+        type: string
+        description: The message of the notification
+      relatedTo:
+        $ref: '../target/notificationTarget.yaml#/$defs/NotificationTarget'
+      created:
+        type: integer
+        format: int64
+        description: Unix timestamp of creation
+      modified:
+        type: integer
+        format: int64
+        description: Unix timestamp of last modification
+    additionalProperties: false
+    examples:
+      - $ref: './notificationObj-example.yaml'

packages/live-status-gateway-api/api/components/notifications/notificationSeverity.yaml

@@ -0,0 +1,9 @@
+$defs:
+  severity:
+    type: string
+    title: NotificationSeverity
+    description: Severity level of the notification.
+    enum:
+      - warning
+      - error
+      - info

packages/live-status-gateway-api/api/components/notifications/target/notificationTarget.yaml

@@ -0,0 +1,16 @@
+$defs:
+  NotificationTarget:
+    title: NotificationTarget
+    description: Describes what the notification is related to
+    oneOf:
+      - $ref: './rundown/notificationTargetRundown.yaml#/$defs/NotificationTargetRundown'
+      - $ref: './rundownPlaylist/notificationTargetRundownPlaylist.yaml#/$defs/NotificationTargetRundownPlaylist'
+      - $ref: './partInstance/notificationTargetPartInstance.yaml#/$defs/NotificationTargetPartInstance'
+      - $ref: './pieceInstance/notificationTargetPieceInstance.yaml#/$defs/NotificationTargetPieceInstance'
+      - $ref: './unknown/notificationTargetUnknown.yaml#/$defs/NotificationTargetUnknown'
+    examples:
+      - $ref: './rundown/notificationTargetRundown-example.yaml'
+      - $ref: './rundownPlaylist/notificationTargetRundownPlaylist-example.yaml'
+      - $ref: './partInstance/notificationTargetPartInstance-example.yaml'
+      - $ref: './pieceInstance/notificationTargetPieceInstance-example.yaml'
+      - $ref: './unknown/notificationTargetUnknown-example.yaml'