fix: add unknown notification target type default case

Co-authored-by: Julian Waller <[email protected]>

Author: justandras

packages/live-status-gateway-api/api/schemas/notifications.yaml

@@ -79,11 +79,13 @@ $defs:
       - $ref: '#/$defs/NotificationTargetRundownPlaylist'
       - $ref: '#/$defs/NotificationTargetPartInstance'
       - $ref: '#/$defs/NotificationTargetPieceInstance'
+      - $ref: '#/$defs/NotificationTargetUnknown'
     examples:
       - $ref: '#/$defs/NotificationTargetRundown/examples/0'
       - $ref: '#/$defs/NotificationTargetRundownPlaylist/examples/0'
       - $ref: '#/$defs/NotificationTargetPartInstance/examples/0'
       - $ref: '#/$defs/NotificationTargetPieceInstance/examples/0'
+      - $ref: '#/$defs/NotificationTargetUnknown/examples/0'
 
   NotificationTargetType:
     type: string
@@ -94,6 +96,7 @@ $defs:
       - playlist
       - partInstance
       - pieceInstance
+      - unknown
 
   NotificationTargetRundown:
     type: object
@@ -175,3 +178,15 @@ $defs:
         rundownId: rd123
         partInstanceId: pi789
         pieceInstanceId: pc1011
+
+  NotificationTargetUnknown:
+    type: object
+    title: NotificationTargetUnknown
+    required: [type]
+    properties:
+      type:
+        $ref: '#/$defs/NotificationTargetType'
+        enum: [unknown]
+    additionalProperties: false
+    examples:
+      - type: unknown

packages/live-status-gateway-api/src/generated/schema.ts

@@ -760,6 +760,7 @@ interface NotificationObj {
 		| NotificationTargetRundownPlaylist
 		| NotificationTargetPartInstance
 		| NotificationTargetPieceInstance
+		| NotificationTargetUnknown
 	/**
 	 * Unix timestamp of creation
 	 */
@@ -796,6 +797,7 @@ enum NotificationTargetType {
 	PLAYLIST = 'playlist',
 	PART_INSTANCE = 'partInstance',
 	PIECE_INSTANCE = 'pieceInstance',
+	UNKNOWN = 'unknown',
 }
 
 interface NotificationTargetRundownPlaylist {
@@ -828,6 +830,13 @@ interface NotificationTargetPieceInstance {
 	pieceInstanceId: string
 }
 
+interface NotificationTargetUnknown {
+	/**
+	 * Possible NotificationTarget types
+	 */
+	type: NotificationTargetType
+}
+
 export {
 	Slash,
 	PongEvent,
@@ -877,4 +886,5 @@ export {
 	NotificationTargetRundownPlaylist,
 	NotificationTargetPartInstance,
 	NotificationTargetPieceInstance,
+	NotificationTargetUnknown,
 }

packages/live-status-gateway/src/topics/helpers/notification/notificationTarget/toNotificationTarget.ts

@@ -12,16 +12,17 @@ import {
 	NotificationTargetRundown,
 	NotificationTargetRundownPlaylist,
 	NotificationTargetType,
+	NotificationTargetUnknown,
 } from '@sofie-automation/live-status-gateway-api'
-import { literal, unprotectString } from '@sofie-automation/server-core-integration'
+import { assertNever, literal, unprotectString } from '@sofie-automation/server-core-integration'
 
 type NotificationTarget =
 	| NotificationTargetRundown
 	| NotificationTargetRundownPlaylist
 	| NotificationTargetPartInstance
 	| NotificationTargetPieceInstance
 
-export function toNotificationTarget(dbTarget: DBNotificationTarget): NotificationTarget {
+export function toNotificationTarget(dbTarget: DBNotificationTarget): NotificationTarget | NotificationTargetUnknown {
 	switch (dbTarget.type) {
 		case DBNotificationTargetType.PARTINSTANCE:
 			return toNotificationTargetPartInstance(dbTarget)
@@ -31,6 +32,9 @@ export function toNotificationTarget(dbTarget: DBNotificationTarget): Notificati
 			return toNotificationTargetPlaylist(dbTarget)
 		case DBNotificationTargetType.PIECEINSTANCE:
 			return toNotificationTargetPieceInstance(dbTarget)
+		default:
+			assertNever(dbTarget)
+			return literal<NotificationTargetUnknown>({ type: NotificationTargetType.UNKNOWN })
 	}
 }
 

packages/live-status-gateway/src/topics/helpers/notification/toNotificationStatus.ts

@@ -5,7 +5,7 @@ import { NotificationObj, NotificationSeverity } from '@sofie-automation/live-st
 import { literal, unprotectString } from '@sofie-automation/server-core-integration'
 import { toNotificationTarget } from './notificationTarget/toNotificationTarget.js'
 
-export function toNotificationStatus(dbNotification: DBNotificationObj): NotificationObj {
+export function toNotificationStatus(dbNotification: DBNotificationObj): NotificationObj | undefined {
 	return literal<NotificationObj>({
 		_id: unprotectString(dbNotification._id),
 		severity: toNotificationSeverity(dbNotification.severity),

packages/live-status-gateway/src/topics/notificationsTopic.ts

@@ -27,7 +27,9 @@ export class NotificationsTopic extends WebSocketTopicBase implements WebSocketT
 	sendStatus(subscribers: Iterable<WebSocket>): void {
 		const message = literal<NotificationsEvent>({
 			event: 'notifications',
-			activeNotifications: this._notifications.map(toNotificationStatus),
+			activeNotifications: this._notifications
+				.map(toNotificationStatus)
+				.filter((notification) => notification !== undefined),
 		})
 
 		this.sendMessage(subscribers, message)