chore: refactor notifications topic schemas

Author: justandras

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

@@ -47,6 +47,8 @@ channels:
     $ref: './topics/packages/packagesTopic.yaml'
   buckets:
     $ref: './topics/buckets/bucketsTopic.yaml'
+  notifications:
+    $ref: './topics/notifications/notificationsTopic.yaml'
 
   # Needed to retain the Slash type from the old schema structure. Eventually this should be removed.
   /:
@@ -89,3 +91,6 @@ channels:
           - messageId: buckets-typeGen
             payload:
               $ref: './components/buckets/messages/bucketsMessage.yaml#/components/messages/bucketsMessage/payload'
+          - messageId: notifications-typeGen
+            payload:
+              $ref: './components/notifications/messages/notificationsMessage.yaml#/components/messages/notificationsMessage/payload'

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'

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

@@ -0,0 +1,11 @@
+$defs:
+  NotificationTargetType:
+    type: string
+    title: NotificationTargetType
+    description: Possible NotificationTarget types
+    enum:
+      - rundown
+      - playlist
+      - partInstance
+      - pieceInstance
+      - unknown

packages/live-status-gateway-api/api/components/notifications/target/partInstance/notificationTargetPartInstance-example.yaml

@@ -0,0 +1,4 @@
+type: partInstance
+studioId: studio01
+rundownId: rd123
+partInstanceId: pi789