feat: time of day pieces SOFIE-197 (#43)

Author: Julusian

meteor/__mocks__/helpers/database.ts

@@ -468,6 +468,7 @@ export async function setupMockShowStyleBlueprint(
 						rundown,
 						globalAdLibPieces: [],
 						globalActions: [],
+						globalPieces: [],
 						baseline: { timelineObjects: [] },
 					}
 				},

meteor/server/api/ingest/packageInfo.ts

@@ -35,6 +35,7 @@ export async function onUpdatedPackageInfo(packageId: ExpectedPackageId, _doc: P
 			case ExpectedPackageDBType.ADLIB_ACTION:
 			case ExpectedPackageDBType.BASELINE_ADLIB_PIECE:
 			case ExpectedPackageDBType.BASELINE_ADLIB_ACTION:
+			case ExpectedPackageDBType.BASELINE_PIECE:
 			case ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS:
 				onUpdatedPackageInfoForRundownDebounce(pkg)
 				break

meteor/server/api/rest/v1/typeConversion.ts

@@ -388,6 +388,7 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Comple
 		allowPieceDirectPlay: apiStudioSettings.allowPieceDirectPlay ?? true, // Backwards compatible
 		enableBuckets: apiStudioSettings.enableBuckets ?? true, // Backwards compatible
 		enableEvaluationForm: apiStudioSettings.enableEvaluationForm ?? true, // Backwards compatible
+		rundownGlobalPiecesPrepareTime: apiStudioSettings.rundownGlobalPiecesPrepareTime,
 	}
 }
 
@@ -413,6 +414,7 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APISt
 		allowPieceDirectPlay: settings.allowPieceDirectPlay,
 		enableBuckets: settings.enableBuckets,
 		enableEvaluationForm: settings.enableEvaluationForm,
+		rundownGlobalPiecesPrepareTime: settings.rundownGlobalPiecesPrepareTime,
 	}
 }
 

meteor/server/lib/rest/v1/studios.ts

@@ -222,4 +222,5 @@ export interface APIStudioSettings {
 	allowPieceDirectPlay?: boolean
 	enableBuckets?: boolean
 	enableEvaluationForm?: boolean
+	rundownGlobalPiecesPrepareTime?: number
 }

meteor/server/migration/1_50_0.ts

@@ -917,7 +917,7 @@ export const addSteps = addMigrationSteps('1.50.0', [
 
 			const partIdLookup = new Map<PieceId | AdLibActionId | RundownBaselineAdLibActionId, PartId>()
 			for (const piece of pieces) {
-				partIdLookup.set(piece._id, piece.startPartId)
+				if (piece.startPartId) partIdLookup.set(piece._id, piece.startPartId)
 			}
 			for (const adlib of adlibPieces) {
 				if (adlib.partId) partIdLookup.set(adlib._id, adlib.partId)

meteor/server/publications/pieceContentStatusUI/rundown/regenerateItems.ts

@@ -107,7 +107,7 @@ export async function regenerateForPieceIds(
 				{
 					_id: protectString(`piece_${pieceId}`),
 
-					partId: pieceDoc.startPartId,
+					partId: pieceDoc.startPartId ?? undefined,
 					rundownId: pieceDoc.startRundownId,
 					pieceId: pieceId,
 
@@ -180,7 +180,7 @@ export async function regenerateForPieceInstanceIds(
 				const res: UIPieceContentStatus = {
 					_id: protectString(`piece_${pieceId}`),
 
-					partId: pieceDoc.piece.startPartId,
+					partId: pieceDoc.piece.startPartId ?? undefined,
 					rundownId: pieceDoc.rundownId,
 					pieceId: pieceId,
 

packages/blueprints-integration/src/api/showStyle.ts

@@ -35,6 +35,8 @@ import type {
 	IBlueprintSegment,
 	IBlueprintPiece,
 	IBlueprintPart,
+	IBlueprintRundownPiece,
+	IBlueprintRundownPieceDB,
 } from '../documents'
 import type { IBlueprintShowStyleVariant, IOutputLayer, ISourceLayer } from '../showStyle'
 import type { TSR, OnGenerateTimelineObj, TimelineObjectCoreExt } from '../timeline'
@@ -260,6 +262,7 @@ export interface BlueprintResultRundown {
 	rundown: IBlueprintRundown
 	globalAdLibPieces: IBlueprintAdLibPiece[]
 	globalActions: IBlueprintActionManifest[]
+	globalPieces: IBlueprintRundownPiece[]
 	baseline: BlueprintResultBaseline
 }
 export interface BlueprintResultSegment {
@@ -286,6 +289,11 @@ export interface BlueprintSyncIngestNewData {
 	actions: IBlueprintActionManifest[]
 	/** A list of adlibs that have pieceInstances in the partInstance in question */
 	referencedAdlibs: IBlueprintAdLibPieceDB[]
+	/**
+	 * The list of pieces which belong to the Rundown, and may be active
+	 * Note: Some of these may have played and been stopped before the current PartInstance
+	 */
+	rundownPieces: IBlueprintRundownPieceDB[]
 }
 
 // TODO: add something like this later?

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

@@ -7,5 +7,6 @@ export * from './pieceInstance'
 export * from './pieceGeneric'
 export * from './playlistTiming'
 export * from './rundown'
+export * from './rundownPiece'
 export * from './rundownPlaylist'
 export * from './segment'

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 Omit<IBlueprintPieceGeneric<TPrivateData, TPublicData>, 'lifespan'> {
+	/** 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/ExpectedPackages.ts

@@ -32,6 +32,7 @@ export type ExpectedPackageFromRundownBaseline =
 	| ExpectedPackageDBFromBaselineAdLibAction
 	| ExpectedPackageDBFromBaselineAdLibPiece
 	| ExpectedPackageDBFromRundownBaselineObjects
+	| ExpectedPackageDBFromBaselinePiece
 
 export type ExpectedPackageDBFromBucket = ExpectedPackageDBFromBucketAdLib | ExpectedPackageDBFromBucketAdLibAction
 
@@ -47,6 +48,7 @@ export enum ExpectedPackageDBType {
 	ADLIB_ACTION = 'adlib_action',
 	BASELINE_ADLIB_PIECE = 'baseline_adlib_piece',
 	BASELINE_ADLIB_ACTION = 'baseline_adlib_action',
+	BASELINE_PIECE = 'baseline_piece',
 	BUCKET_ADLIB = 'bucket_adlib',
 	BUCKET_ADLIB_ACTION = 'bucket_adlib_action',
 	RUNDOWN_BASELINE_OBJECTS = 'rundown_baseline_objects',
@@ -79,6 +81,13 @@ export interface ExpectedPackageDBFromPiece extends ExpectedPackageDBBase {
 	/** The rundown of the Piece this package belongs to */
 	rundownId: RundownId
 }
+export interface ExpectedPackageDBFromBaselinePiece extends ExpectedPackageDBBase {
+	fromPieceType: ExpectedPackageDBType.BASELINE_PIECE
+	/** The Piece this package belongs to */
+	pieceId: PieceId
+	/** The rundown of the Piece this package belongs to */
+	rundownId: RundownId
+}
 
 export interface ExpectedPackageDBFromBaselineAdLibPiece extends ExpectedPackageDBBase {
 	fromPieceType: ExpectedPackageDBType.BASELINE_ADLIB_PIECE