chore(lsg): fix lsg RundownPlaylistTiming type

Author: justandras

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

@@ -39,31 +39,7 @@ $defs:
         description: Optional arbitrary data
       timing:
         description: Timing information about the active playlist
-        type: object
-        title: ActivePlaylistTiming
-        properties:
-          timingMode:
-            description: 'Timing mode for the playlist.'
-            type: string
-            title: ActivePlaylistTimingMode
-            enum:
-              - none
-              - forward-time
-              - back-time
-          startedPlayback:
-            description: Unix timestamp of when the playlist started (milliseconds)
-            type: number
-          expectedStart:
-            description: Unix timestamp of when the playlist is expected to start (milliseconds). Required when the timingMode is set to forward-time.
-            type: number
-          expectedDurationMs:
-            description: Duration of the playlist in ms
-            type: number
-          expectedEnd:
-            description: Unix timestamp of when the playlist is expected to end (milliseconds) Required when the timingMode is set to back-time.
-            type: number
-        required: [timingMode]
-        additionalProperties: false
+        $ref: 'timing/rundownPlaylistTiming.yaml#/$defs/rundownPlaylistTiming'
       quickLoop:
         description: Information about the current quickLoop, if any
         type: object

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

@@ -153,9 +153,9 @@ interface ActivePlaylistEvent {
 	 */
 	publicData?: any
 	/**
-	 * Timing information about the active playlist
+	 * Timing information about a playlist or rundown
 	 */
-	timing: ActivePlaylistTiming
+	timing: RundownPlaylistTiming
 	/**
 	 * Information about the current quickLoop, if any
 	 */
@@ -336,35 +336,35 @@ interface PartStatus {
 }
 
 /**
- * Timing information about the active playlist
+ * Timing information about a playlist or rundown
  */
-interface ActivePlaylistTiming {
+interface RundownPlaylistTiming {
 	/**
-	 * Timing mode for the playlist.
+	 * Timing mode for a playlist or rundown.
 	 */
-	timingMode: ActivePlaylistTimingMode
+	timingMode: RundownPlaylistTimingMode
 	/**
-	 * Unix timestamp of when the playlist started (milliseconds)
+	 * Unix timestamp of when a playlist or rundown started (milliseconds)
 	 */
 	startedPlayback?: number
 	/**
-	 * Unix timestamp of when the playlist is expected to start (milliseconds). Required when the timingMode is set to forward-time.
+	 * Unix timestamp of when a playlist or rundown is expected to start (milliseconds). Required when the timingMode is set to forward-time.
 	 */
 	expectedStart?: number
 	/**
-	 * Duration of the playlist in ms
+	 * Duration of a playlist or rundown in ms
 	 */
 	expectedDurationMs?: number
 	/**
-	 * Unix timestamp of when the playlist is expected to end (milliseconds) Required when the timingMode is set to back-time.
+	 * Unix timestamp of when a playlist or rundown is expected to end (milliseconds) Required when the timingMode is set to back-time.
 	 */
 	expectedEnd?: number
 }
 
 /**
- * Timing mode for the playlist.
+ * Timing mode for a playlist or rundown.
  */
-enum ActivePlaylistTimingMode {
+enum RundownPlaylistTimingMode {
 	NONE = 'none',
 	FORWARD_MINUS_TIME = 'forward-time',
 	BACK_MINUS_TIME = 'back-time',
@@ -483,41 +483,6 @@ interface Rundown {
 	segments: ExtendedSegment[]
 }
 
-/**
- * Timing information about a playlist or rundown
- */
-interface RundownPlaylistTiming {
-	/**
-	 * Timing mode for a playlist or rundown.
-	 */
-	timingMode: RundownPlaylistTimingMode
-	/**
-	 * Unix timestamp of when a playlist or rundown started (milliseconds)
-	 */
-	startedPlayback?: number
-	/**
-	 * Unix timestamp of when a playlist or rundown is expected to start (milliseconds). Required when the timingMode is set to forward-time.
-	 */
-	expectedStart?: number
-	/**
-	 * Duration of a playlist or rundown in ms
-	 */
-	expectedDurationMs?: number
-	/**
-	 * Unix timestamp of when a playlist or rundown is expected to end (milliseconds) Required when the timingMode is set to back-time.
-	 */
-	expectedEnd?: number
-}
-
-/**
- * Timing mode for a playlist or rundown.
- */
-enum RundownPlaylistTimingMode {
-	NONE = 'none',
-	FORWARD_MINUS_TIME = 'forward-time',
-	BACK_MINUS_TIME = 'back-time',
-}
-
 interface ExtendedSegment {
 	/**
 	 * Unique id of the segment
@@ -879,15 +844,13 @@ export {
 	CurrentSegmentPart,
 	CurrentSegmentPartTiming,
 	PartStatus,
-	ActivePlaylistTiming,
-	ActivePlaylistTimingMode,
+	RundownPlaylistTiming,
+	RundownPlaylistTimingMode,
 	ActivePlaylistQuickLoop,
 	QuickLoopMarker,
 	QuickLoopMarkerType,
 	ExtendedActivePlaylistEvent,
 	Rundown,
-	RundownPlaylistTiming,
-	RundownPlaylistTimingMode,
 	ExtendedSegment,
 	SegmentTiming,
 	ActivePiecesEvent,

packages/live-status-gateway/src/topics/helpers/playlist/extendedPlaylistStatus.ts

@@ -1,5 +1,5 @@
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
-import { ActivePlaylistTimingMode, ExtendedActivePlaylistEvent } from '@sofie-automation/live-status-gateway-api'
+import { ExtendedActivePlaylistEvent, RundownPlaylistTimingMode } from '@sofie-automation/live-status-gateway-api'
 import { literal, unprotectString } from '@sofie-automation/server-core-integration'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import { ExtendedPlaylistStatusCache } from './playlistStatus.js'
@@ -23,7 +23,7 @@ export function toExtendedPlaylistStatus(props: ExtendedPlaylistStatusCache): Ex
 				id: unprotectString(activePlaylist._id),
 				externalId: activePlaylist.externalId,
 				name: activePlaylist.name,
-				rundownIds: activePlaylist.rundownIdsInOrder.map((r) => unprotectString(r)),
+				rundowns: activePlaylist.rundownIdsInOrder.map((r) => unprotectString(r)),
 				currentPart: toCurrentPartStatus(props, currentPart),
 				currentSegment: toCurrentSegmentStatus({ ...props }, currentPart, currentSegmentParts),
 				// TODO: add all fields to this object, then add parts to it.
@@ -42,14 +42,14 @@ export function toExtendedPlaylistStatus(props: ExtendedPlaylistStatusCache): Ex
 				id: null,
 				externalId: null,
 				name: '',
-				rundownIds: [],
+				rundowns: [],
 				currentPart: null,
 				currentSegment: null,
 				nextPart: null,
 				quickLoop: undefined,
 				publicData: undefined,
 				timing: {
-					timingMode: ActivePlaylistTimingMode.NONE,
+					timingMode: RundownPlaylistTimingMode.NONE,
 				},
 			})
 }

packages/live-status-gateway/src/topics/helpers/playlist/playlistStatus.ts

@@ -1,5 +1,5 @@
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
-import { ActivePlaylistEvent, ActivePlaylistTimingMode } from '@sofie-automation/live-status-gateway-api'
+import { ActivePlaylistEvent, RundownPlaylistTimingMode } from '@sofie-automation/live-status-gateway-api'
 import { literal, unprotectString } from '@sofie-automation/server-core-integration'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
@@ -99,7 +99,7 @@ export function toPlaylistStatus(props: PlaylistStatusCache): ActivePlaylistEven
 				quickLoop: undefined,
 				publicData: undefined,
 				timing: {
-					timingMode: ActivePlaylistTimingMode.NONE,
+					timingMode: RundownPlaylistTimingMode.NONE,
 				},
 			})
 }

packages/live-status-gateway/src/topics/helpers/playlist/timing.ts

@@ -1,23 +1,28 @@
 import { PlaylistTimingType, RundownPlaylistTiming } from '@sofie-automation/blueprints-integration'
-import { ActivePlaylistTimingMode, ActivePlaylistTiming } from '@sofie-automation/live-status-gateway-api'
+import {
+	RundownPlaylistTiming as RundownPlaylistTimingStatus,
+	RundownPlaylistTimingMode,
+} from '@sofie-automation/live-status-gateway-api'
 import { assertNever } from '@sofie-automation/server-core-integration'
 
-export function translatePlaylistTimingType(type: PlaylistTimingType): ActivePlaylistTimingMode {
+export function translatePlaylistTimingType(type: PlaylistTimingType): RundownPlaylistTimingMode {
 	switch (type) {
 		case PlaylistTimingType.None:
-			return ActivePlaylistTimingMode.NONE
+			return RundownPlaylistTimingMode.NONE
 		case PlaylistTimingType.BackTime:
-			return ActivePlaylistTimingMode.BACK_MINUS_TIME
+			return RundownPlaylistTimingMode.BACK_MINUS_TIME
 		case PlaylistTimingType.ForwardTime:
-			return ActivePlaylistTimingMode.FORWARD_MINUS_TIME
+			return RundownPlaylistTimingMode.FORWARD_MINUS_TIME
 		default:
 			assertNever(type)
 			// Cast and return the value anyway, so that the application works
-			return type as any as ActivePlaylistTimingMode
+			return type as any as RundownPlaylistTimingMode
 	}
 }
 
-export function toPlaylistTiming(timing: RundownPlaylistTiming & { startedPlayback?: number }): ActivePlaylistTiming {
+export function toPlaylistTiming(
+	timing: RundownPlaylistTiming & { startedPlayback?: number }
+): RundownPlaylistTimingStatus {
 	const timingMode = translatePlaylistTimingType(timing.type)
 
 	const base = {