chore: add expected duration to all part types

Author: justandras

packages/live-status-gateway-api/api/components/part/extendedPartStatus/extendedPartStatus-example.yaml

@@ -12,3 +12,4 @@ invalidReason:
 pieces:
   - $ref: '../../piece/extendedPieceStatus/extendedPieceStatus-example.yaml'
 floated: false
+expectedDuration: 200

packages/live-status-gateway-api/api/components/part/extendedPartStatus/extendedPartStatus.yaml

@@ -34,6 +34,9 @@ $defs:
           floated:
             description: When the NRCS informs us that the producer marked the part as floated, we can prevent the user from TAKE'ing and NEXT'ing it, but still have it visible and allow manipulation
             type: boolean
+          expectedDuration:
+            description: Expected duration of the part, in milliseconds
+            type: number
           pieces:
             description: All pieces in this part
             type: array

packages/live-status-gateway-api/api/components/part/partStatus/partStatus-example.yaml

@@ -4,3 +4,4 @@ pieces:
   - $ref: '../../piece/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus/examples/0'
 publicData:
   partType: 'intro'
+expectedDuration: 200

packages/live-status-gateway-api/api/components/part/partStatus/partStatus.yaml

@@ -15,6 +15,9 @@ $defs:
             type: array
             items:
               $ref: '../../piece/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus'
+          expectedDuration:
+            description: Expected duration of the part, in milliseconds
+            type: number
           publicData:
             description: Optional arbitrary data
         required: [id, name, segmentId, pieces]

packages/live-status-gateway-api/api/components/timing/pieceTiming/pieceTiming-example.yaml

@@ -1,3 +1,4 @@
 startMs: 1600000060000
 durationMs: 1600000075000
 lifespan: part-only
+isAbsolute: true

packages/live-status-gateway-api/api/components/timing/pieceTiming/pieceTiming.yaml

@@ -10,6 +10,9 @@ $defs:
       durationMs:
         description: The duration of the piece (milliseconds).
         type: number
+      isAbsolute:
+        description: Some pieces can be timed to be absolute (using wall time) rather than relative to the part
+        type: boolean
       lifespan:
         $ref: '../pieceLifespan/pieceLifespan.yaml'
     required: [startMs, lifespan]

packages/live-status-gateway-api/scripts/generate-schema-types.mjs

@@ -67,7 +67,7 @@ if (!asyncApiDoc.document) {
 	const filteredDiagnostics = asyncApiDoc.diagnostics.filter((d) => d.code !== 'asyncapi-latest-version')
 
 	console.error('No document was produced from the asyncapi parser')
-	console.error(JSON.stringify(asyncApiDoc.diagnostics))
+	console.error(JSON.stringify(asyncApiDoc.diagnostics, null, 2))
 
 	// eslint-disable-next-line n/no-process-exit
 	process.exit(5)

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

@@ -444,6 +444,9 @@ channels:
                                           - camera
                                         publicData:
                                           switcherSource: 1
+                                expectedDuration:
+                                  description: Expected duration of the part, in milliseconds
+                                  type: number
                                 publicData:
                                   description: Optional arbitrary data
                               required:
@@ -458,6 +461,7 @@ channels:
                                 - *a13
                               publicData: &a16
                                 partType: intro
+                              expectedDuration: 200
                               id: H5CBGYjThrMSmaYvRaa5FVKJIzk_
                               name: Intro
                               autoNext: false
@@ -505,6 +509,7 @@ channels:
                           segmentId: n1mOVd5_K5tt4sfk6HYfTuwumGQ_
                           pieces: *a15
                           publicData: *a16
+                          expectedDuration: 200
                           id: H5CBGYjThrMSmaYvRaa5FVKJIzk_
                           name: Intro
                           autoNext: false
@@ -937,6 +942,9 @@ channels:
                                                 but still have it visible and
                                                 allow manipulation
                                               type: boolean
+                                            expectedDuration:
+                                              description: Expected duration of the part, in milliseconds
+                                              type: number
                                             pieces:
                                               description: All pieces in this part
                                               type: array
@@ -987,6 +995,11 @@ channels:
                                                         durationMs:
                                                           description: The duration of the piece (milliseconds).
                                                           type: number
+                                                        isAbsolute:
+                                                          description: Some pieces can be timed to be absolute (using wall time) rather
+                                                            than relative to the
+                                                            part
+                                                          type: boolean
                                                         lifespan:
                                                           type: string
                                                           title: PieceLifespan
@@ -1006,6 +1019,7 @@ channels:
                                                           startMs: 1600000060000
                                                           durationMs: 1600000075000
                                                           lifespan: part-only
+                                                          isAbsolute: true
                                                   required:
                                                     - id
                                                     - name

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

@@ -210,6 +210,10 @@ interface CurrentPartStatus {
 	 * All pieces in this part
 	 */
 	pieces: PieceStatus[]
+	/**
+	 * Expected duration of the part, in milliseconds
+	 */
+	expectedDuration?: number
 	/**
 	 * Optional arbitrary data
 	 */
@@ -357,6 +361,10 @@ interface PartStatus {
 	 * All pieces in this part
 	 */
 	pieces: PieceStatus[]
+	/**
+	 * Expected duration of the part, in milliseconds
+	 */
+	expectedDuration?: number
 	/**
 	 * Optional arbitrary data
 	 */
@@ -627,6 +635,10 @@ interface ExtendedPartStatus {
 	 * When the NRCS informs us that the producer marked the part as floated, we can prevent the user from TAKE'ing and NEXT'ing it, but still have it visible and allow manipulation
 	 */
 	floated?: boolean
+	/**
+	 * Expected duration of the part, in milliseconds
+	 */
+	expectedDuration?: number
 	/**
 	 * All pieces in this part
 	 */
@@ -708,6 +720,10 @@ interface PieceTiming {
 	 * The duration of the piece (milliseconds).
 	 */
 	durationMs?: number
+	/**
+	 * Some pieces can be timed to be absolute (using wall time) rather than relative to the part
+	 */
+	isAbsolute?: boolean
 	/**
 	 * Whether and how the piece is infinite
 	 */

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

@@ -6,7 +6,7 @@ import {
 	PartStatus,
 } from '@sofie-automation/live-status-gateway-api'
 import { literal, unprotectString } from '@sofie-automation/server-core-integration'
-import { calculateCurrentPartTiming } from '../partTiming.js'
+import { calculateCurrentPartInstanceTiming } from '../partTiming.js'
 import { toExtendedPieceStatus, toPieceStatus } from '../pieceStatus.js'
 import { ExtendedPlaylistStatusCache, PlaylistStatusCache } from '../playlist/playlistStatus.js'
 import { interpollateTranslation } from '@sofie-automation/corelib/dist/TranslatableMessage'
@@ -20,7 +20,10 @@ export function toCurrentPartStatus(cache: PlaylistStatusCache, part: DBPart | n
 
 	return literal<CurrentPartStatus>({
 		...base,
-		timing: calculateCurrentPartTiming(cache.currentPartInstance, cache.partInstancesInCurrentSegment ?? []),
+		timing: calculateCurrentPartInstanceTiming(
+			cache.currentPartInstance,
+			cache.partInstancesInCurrentSegment ?? []
+		),
 	})
 }
 
@@ -30,14 +33,15 @@ export function toPartStatus(
 ): PartStatus | null {
 	if (!part) return null
 
-	const base = {
+	const base = literal<PartStatus>({
 		id: unprotectString(part._id),
 		name: part.title,
 		autoNext: part.autoNext ?? false,
 		segmentId: unprotectString(part.segmentId),
 		pieces: (pieceInstancesInCurrentPartInstance ?? []).map((piece) => toPieceStatus(piece, showStyleBaseExt)),
 		publicData: part.publicData,
-	}
+		expectedDuration: part.expectedDuration,
+	})
 
 	return literal<PartStatus>(base)
 }
@@ -64,6 +68,7 @@ export function toExtendedPartStatus(
 			toExtendedPieceStatus(piece, showStyleBaseExt)
 		),
 		publicData: part.publicData,
+		expectedDuration: part.expectedDuration,
 	})
 }