feat(lsg): add parts to segments

Author: justandras

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

@@ -36,7 +36,7 @@ $defs:
         description: All segments in the playlist
         type: array
         items:
-          $ref: 'segments.yaml#/$defs/segment'
+          $ref: 'segments.yaml#/$defs/extendedSegment'
       nextPart:
         description: The next Part - if empty, no part will follow live part
         $ref: '#/$defs/part'

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

@@ -73,3 +73,56 @@ $defs:
           countdownType: segment_budget_duration
         publicData:
           containsLiveSource: true
+  extendedSegment:
+    type: object
+    title: Extended Segment
+    properties:
+      id:
+        description: Unique id of the segment
+        type: string
+      identifier:
+        description: User-facing identifier that can be used to identify the contents of a segment in the Rundown source system
+        type: string
+      rundownId:
+        description: Unique id of the rundown this segment belongs to
+        type: string
+      name:
+        description: Name of the segment
+        type: string
+      parts:
+        description: Parts belonging to a segment
+        type: array
+        items:
+          $ref: 'activePlaylist.yaml#/$defs/partBase'
+      timing:
+        type: object
+        title: SegmentTiming
+        properties:
+          expectedDurationMs:
+            description: Expected duration of the segment (milliseconds)
+            type: number
+          budgetDurationMs:
+            description: Budget duration of the segment (milliseconds)
+            type: number
+          countdownType:
+            description: 'Countdown type within the segment. Default: `part_expected_duration`'
+            type: string
+            title: SegmentCountdownType
+            enum:
+              - part_expected_duration
+              - segment_budget_duration
+        required: [expectedDurationMs]
+      publicData:
+        description: Optional arbitrary data
+    required: [id, rundownId, name, timing]
+    additionalProperties: false
+    examples:
+      - id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+        rundownId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'
+        name: 'Segment 0'
+        timing:
+          expectedDurationMs: 15000
+          budgetDurationMs: 20000
+          countdownType: segment_budget_duration
+        publicData:
+          containsLiveSource: true

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

@@ -440,7 +440,7 @@ interface ExtendedActivePlaylistEvent {
 	/**
 	 * All segments in the playlist
 	 */
-	segments?: Segment[]
+	segments?: ExtendedSegment[]
 	nextPart: PartStatus | null
 	/**
 	 * Optional arbitrary data
@@ -456,7 +456,7 @@ interface ExtendedActivePlaylistEvent {
 	quickLoop?: ActivePlaylistQuickLoop
 }
 
-interface Segment {
+interface ExtendedSegment {
 	/**
 	 * Unique id of the segment
 	 */
@@ -473,6 +473,10 @@ interface Segment {
 	 * Name of the segment
 	 */
 	name: string
+	/**
+	 * Parts belonging to a segment
+	 */
+	parts?: PartStatus[]
 	timing: SegmentTiming
 	/**
 	 * Optional arbitrary data
@@ -520,6 +524,30 @@ interface SegmentsEvent {
 	segments: Segment[]
 }
 
+interface Segment {
+	/**
+	 * Unique id of the segment
+	 */
+	id: string
+	/**
+	 * User-facing identifier that can be used to identify the contents of a segment in the Rundown source system
+	 */
+	identifier?: string
+	/**
+	 * Unique id of the rundown this segment belongs to
+	 */
+	rundownId: string
+	/**
+	 * Name of the segment
+	 */
+	name: string
+	timing: SegmentTiming
+	/**
+	 * Optional arbitrary data
+	 */
+	publicData?: any
+}
+
 interface AdLibsEvent {
 	event: 'adLibs'
 	/**
@@ -795,10 +823,11 @@ export {
 	QuickLoopMarker,
 	QuickLoopMarkerType,
 	ExtendedActivePlaylistEvent,
-	Segment,
+	ExtendedSegment,
 	SegmentTiming,
 	ActivePiecesEvent,
 	SegmentsEvent,
+	Segment,
 	AdLibsEvent,
 	AdLibStatus,
 	AdLibActionType,

packages/live-status-gateway/src/topics/helpers/part/partStatus.ts

@@ -34,3 +34,22 @@ export function toPartStatus(
 
 	return literal<PartStatus>(base)
 }
+
+export function toExtendedPartStatus(
+	{ pieceInstancesInCurrentPartInstance, showStyleBaseExt }: PlaylistStatusCache,
+	part: DBPart | null
+): PartStatus | null {
+	if (!part) return null
+
+	const base = {
+		id: unprotectString(part._id),
+		name: part.title,
+		autoNext: part.autoNext,
+		segmentId: unprotectString(part.segmentId),
+		// TODO: fix pieces
+		pieces: (pieceInstancesInCurrentPartInstance ?? []).map((piece) => toPieceStatus(piece, showStyleBaseExt)),
+		publicData: part.publicData,
+	}
+
+	return literal<PartStatus>(base)
+}

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

@@ -5,7 +5,7 @@ import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import { PlaylistStatusCache } from './playlistStatus.js'
 import { toPlaylistTiming } from './timing.js'
 import { transformQuickLoopStatus } from './quickLoop.js'
-import { toCurrentSegmentStatus, toSegmentStatus } from '../segment/segmentStatus.js'
+import { toCurrentSegmentStatus, toExtendedSegmentStatus } from '../segment/segmentStatus.js'
 import { toCurrentPartStatus, toPartStatus } from '../part/partStatus.js'
 
 export function toExtendedPlaylistStatus(props: PlaylistStatusCache): ExtendedActivePlaylistEvent {
@@ -29,7 +29,7 @@ export function toExtendedPlaylistStatus(props: PlaylistStatusCache): ExtendedAc
 				// TODO: add all fields to this object, then add parts to it.
 				segments: segmentsById
 					? Object.entries<DBSegment | undefined>(segmentsById)
-							.map(([_id, segment]) => (segment ? toSegmentStatus(props, segment) : null))
+							.map(([_id, segment]) => (segment ? toExtendedSegmentStatus(props, segment) : null))
 							.filter((segment) => segment !== null)
 					: [],
 				nextPart: toPartStatus(props, nextPart),

packages/live-status-gateway/src/topics/helpers/segment/segmentStatus.ts

@@ -1,10 +1,11 @@
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
-import { CurrentSegment, Segment as SegmentStatus } from '@sofie-automation/live-status-gateway-api'
+import { CurrentSegment, ExtendedSegment, Segment as SegmentStatus } from '@sofie-automation/live-status-gateway-api'
 import { literal, unprotectString } from '@sofie-automation/server-core-integration'
 import { getCurrentSegmentParts } from '../segmentParts.js'
 import { calculateCurrentSegmentTiming, calculateSegmentTiming } from '../segmentTiming.js'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import { PlaylistStatusCache } from '../playlist/playlistStatus.js'
+import { toPartStatus } from '../part/partStatus.js'
 
 export function toCurrentSegmentStatus(
 	{
@@ -33,6 +34,18 @@ export function toCurrentSegmentStatus(
 }
 
 // TODO: use proper types here
+export function toExtendedSegmentStatus(cache: PlaylistStatusCache, segment: DBSegment): ExtendedSegment | null {
+	const { partsBySegmentId } = cache
+	const segmentId = unprotectString(segment._id)
+	const segmentStatus = toSegmentStatus(cache, segment)
+	if (!segmentStatus) return null
+
+	return {
+		...segmentStatus,
+		parts: partsBySegmentId[segmentId].map((part) => toPartStatus(cache, part)).filter((part) => part !== null),
+	}
+}
+
 export function toSegmentStatus({ partsBySegmentId }: PlaylistStatusCache, segment: DBSegment): SegmentStatus | null {
 	const segmentId = unprotectString(segment._id)
 	return {