wip

Author: Julusian

packages/blueprints-integration/src/documents/pieceInstance.ts

@@ -4,7 +4,7 @@ import type { IBlueprintPieceDB } from './piece'
 export interface IBlueprintPieceInstance<TPrivateData = unknown, TPublicData = unknown> {
 	_id: string
 	/** The part instace this piece belongs to */
-	partInstanceId: string
+	partInstanceId: string | null
 
 	/** If this piece has been created play-time using an AdLibPiece, this should be set to it's source piece */
 	adLibSourceId?: string

packages/blueprints-integration/src/documents/rundownPiece.ts

@@ -0,0 +1,29 @@
+import { IBlueprintPieceGeneric } from './pieceGeneric'
+
+/**
+ * A variant of a Piece, that is owned by the Rundown.
+ * This
+ */
+export interface IBlueprintRundownPiece<TPrivateData = unknown, TPublicData = unknown>
+	extends IBlueprintPieceGeneric<TPrivateData, TPublicData> {
+	/** When the piece should be active on the timeline. */
+	enable: {
+		start: number
+		duration?: number
+
+		// For now, these pieces are always absolute (using wall time) rather than relative to the rundown
+		isAbsolute: true
+	}
+
+	/** Whether the piece is a real piece, or exists as a marker to stop an infinite piece. If virtual, it does not add any contents to the timeline */
+	virtual?: boolean
+
+	/** Whether the piece affects the output of the Studio or is describing an invisible state within the Studio */
+	notInVision?: boolean
+}
+
+/** The Rundown piece sent from Core */
+export interface IBlueprintRundownPieceDB<TPrivateData = unknown, TPublicData = unknown>
+	extends IBlueprintRundownPiece<TPrivateData, TPublicData> {
+	_id: string
+}

packages/corelib/src/dataModel/PieceInstance.ts

@@ -34,8 +34,11 @@ export interface PieceInstance {
 	_id: PieceInstanceId
 	/** The rundown this piece belongs to */
 	rundownId: RundownId
-	/** The part instace this piece belongs to */
-	partInstanceId: PartInstanceId
+	/**
+	 * The part instance this piece belongs to.
+	 * If null, the instance belongs to the rundown itself.
+	 */
+	partInstanceId: PartInstanceId | null
 
 	/** Whether this PieceInstance is a temprorary wrapping of a Piece */
 	readonly isTemporary?: boolean

packages/corelib/src/dataModel/RundownPlaylist.ts

@@ -26,7 +26,7 @@ export interface ABSessionInfo {
 	/** Set if the session is being used by an infinite PieceInstance */
 	infiniteInstanceId?: PieceInstanceInfiniteId
 	/** Set to the PartInstances this session is used by, if not just used for lookahead */
-	partInstanceIds?: Array<PartInstanceId>
+	partInstanceIds?: Array<PartInstanceId | null>
 }
 
 export interface ABSessionAssignment {

packages/job-worker/src/blueprints/__tests__/context-events.test.ts

@@ -273,22 +273,19 @@ describe('Test blueprint api context', () => {
 				rundownId,
 			})) as PieceInstance
 			expect(pieceInstance).toBeTruthy()
+			expect(pieceInstance.partInstanceId).toBe(partInstance._id)
 
 			// Check what was generated
 			const context = await getContext(rundown, undefined, partInstance, undefined)
-			await expect(
-				context.getPieceInstances(unprotectString(pieceInstance.partInstanceId))
-			).resolves.toHaveLength(3)
+			await expect(context.getPieceInstances(unprotectString(partInstance._id))).resolves.toHaveLength(3)
 
 			// mark one of the piece as different activation
 			await jobContext.mockCollections.PieceInstances.update(pieceInstance._id, {
 				$set: { playlistActivationId: protectString('another activation') },
 			})
 
 			// should now be less
-			await expect(
-				context.getPieceInstances(unprotectString(pieceInstance.partInstanceId))
-			).resolves.toHaveLength(2)
+			await expect(context.getPieceInstances(unprotectString(partInstance._id))).resolves.toHaveLength(2)
 		})
 
 		test('getSegment - no id', async () => {

packages/job-worker/src/blueprints/context/services/__tests__/PartAndPieceInstanceActionService.test.ts

@@ -57,6 +57,7 @@ import { postProcessPieces, postProcessTimelineObjects } from '../../../postProc
 import { ActionPartChange, PartAndPieceInstanceActionService } from '../PartAndPieceInstanceActionService'
 import { mock } from 'jest-mock-extended'
 import { QuickLoopService } from '../../../../playout/model/services/QuickLoopService'
+import { SelectedPartInstance } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 const { postProcessPieces: postProcessPiecesOrig, postProcessTimelineObjects: postProcessTimelineObjectsOrig } =
 	jest.requireActual('../../../postProcess')
 
@@ -233,10 +234,13 @@ describe('Test blueprint api context', () => {
 		nextPartInstance: PlayoutPartInstanceModel | DBPartInstance | PieceInstance | undefined | null,
 		previousPartInstance?: PlayoutPartInstanceModel | DBPartInstance | PieceInstance | null
 	) {
-		const convertInfo = (info: PlayoutPartInstanceModel | DBPartInstance | PieceInstance | null) => {
+		const convertInfo = (
+			info: PlayoutPartInstanceModel | DBPartInstance | PieceInstance | null
+		): SelectedPartInstance | null => {
 			if (!info) {
 				return null
 			} else if ('partInstanceId' in info) {
+				if (!info.partInstanceId) return null
 				return {
 					partInstanceId: info.partInstanceId,
 					rundownId: info.rundownId,

packages/job-worker/src/playout/__tests__/playout.test.ts

@@ -43,7 +43,10 @@ import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartIns
 import { ReadonlyDeep } from 'type-fest'
 import { adjustFakeTime, getCurrentTime, useFakeCurrentTime } from '../../__mocks__/time'
 import { PieceLifespan } from '@sofie-automation/blueprints-integration'
-import { PlayoutChangedType } from '@sofie-automation/shared-lib/dist/peripheralDevice/peripheralDeviceAPI'
+import {
+	PlayoutChangedResult,
+	PlayoutChangedType,
+} from '@sofie-automation/shared-lib/dist/peripheralDevice/peripheralDeviceAPI'
 import { ProcessedShowStyleCompound } from '../../jobs'
 import { handleOnPlayoutPlaybackChanged } from '../timings'
 import { sleep } from '@sofie-automation/shared-lib/dist/lib/lib'
@@ -605,7 +608,7 @@ describe('Playout API', () => {
 										: now) +
 									Math.random() * TIME_RANDOM,
 							},
-						}
+						} satisfies PlayoutChangedResult
 					}),
 				],
 			})
@@ -698,7 +701,7 @@ describe('Playout API', () => {
 										: now) +
 									Math.random() * TIME_RANDOM,
 							},
-						}
+						} satisfies PlayoutChangedResult
 					}),
 				],
 			})

packages/job-worker/src/playout/abPlayback/abSessionHelper.ts

@@ -108,6 +108,7 @@ export class AbSessionHelper {
 		}
 
 		// We only want to consider sessions already tagged to this partInstance
+		// nocommit - is this sane for piece instances without a partInstanceId?
 		const existingSession = sessionsToConsider.find((s) =>
 			s.partInstanceIds?.includes(pieceInstance.partInstanceId)
 		)

packages/job-worker/src/playout/model/implementation/LoadPlayoutModel.ts

@@ -260,7 +260,7 @@ async function loadPartInstances(
 	context: JobContext,
 	playlist: ReadonlyDeep<DBRundownPlaylist>,
 	rundownIds: RundownId[]
-): Promise<{ partInstances: DBPartInstance[]; groupedPieceInstances: Map<PartInstanceId, PieceInstance[]> }> {
+): Promise<{ partInstances: DBPartInstance[]; groupedPieceInstances: Map<PartInstanceId | null, PieceInstance[]> }> {
 	const selectedPartInstanceIds = _.compact([
 		playlist.currentPartInfo?.partInstanceId,
 		playlist.nextPartInfo?.partInstanceId,

packages/job-worker/src/playout/model/implementation/PlayoutModelImpl.ts

@@ -96,7 +96,7 @@ export class PlayoutModelReadonlyImpl implements PlayoutModelReadonly {
 		peripheralDevices: ReadonlyDeep<PeripheralDevice[]>,
 		playlist: DBRundownPlaylist,
 		partInstances: DBPartInstance[],
-		groupedPieceInstances: Map<PartInstanceId, PieceInstance[]>,
+		groupedPieceInstances: Map<PartInstanceId | null, PieceInstance[]>,
 		rundowns: PlayoutRundownModelImpl[],
 		timeline: TimelineComplete | undefined
 	) {
@@ -120,7 +120,7 @@ export class PlayoutModelReadonlyImpl implements PlayoutModelReadonly {
 
 	private createPartInstanceModelImpls(
 		partInstances: DBPartInstance[],
-		groupedPieceInstances: Map<PartInstanceId, PieceInstance[]>
+		groupedPieceInstances: Map<PartInstanceId | null, PieceInstance[]>
 	) {
 		const allPartInstances: PlayoutPartInstanceModelImpl[] = []
 		for (const partInstance of partInstances) {
@@ -300,7 +300,7 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		peripheralDevices: ReadonlyDeep<PeripheralDevice[]>,
 		playlist: DBRundownPlaylist,
 		partInstances: DBPartInstance[],
-		groupedPieceInstances: Map<PartInstanceId, PieceInstance[]>,
+		groupedPieceInstances: Map<PartInstanceId | null, PieceInstance[]>,
 		rundowns: PlayoutRundownModelImpl[],
 		timeline: TimelineComplete | undefined
 	) {