feat: use segmentHeaderNotes

Author: Julusian

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

@@ -91,6 +91,9 @@ export interface IBlueprintMutatablePart<TPrivateData = unknown, TPublicData = u
 	/** User-facing identifier that can be used by the User to identify the contents of a segment in the Rundown source system */
 	identifier?: string
 
+	/** User-facing notes shown in the segment header */
+	segmentHeaderNotes?: ITranslatableMessage[]
+
 	/** MediaObjects that when created/updated, should cause the blueprint to be rerun for the Segment of this Part */
 	hackListenToMediaObjectUpdates?: HackPartMediaObjectSubscription[]
 

packages/job-worker/src/blueprints/context/lib.ts

@@ -51,6 +51,7 @@ import {
 	IBlueprintShowStyleVariant,
 	IOutputLayer,
 	ISourceLayer,
+	ITranslatableMessage,
 	PieceAbSessionInfo,
 	RundownPlaylistTiming,
 } from '@sofie-automation/blueprints-integration'
@@ -138,6 +139,7 @@ export const PlayoutMutatablePartSampleKeys = allKeysOfObject<PlayoutMutatablePa
 	displayDurationGroup: true,
 	displayDuration: true,
 	identifier: true,
+	segmentHeaderNotes: true,
 	hackListenToMediaObjectUpdates: true,
 	userEditOperations: true,
 	userEditProperties: true,
@@ -326,6 +328,7 @@ export function convertPartToBlueprints(part: ReadonlyDeep<DBPart>): IBlueprintP
 		displayDurationGroup: part.displayDurationGroup,
 		displayDuration: part.displayDuration,
 		identifier: part.identifier,
+		segmentHeaderNotes: clone<ITranslatableMessage[] | undefined>(part.segmentHeaderNotes),
 		hackListenToMediaObjectUpdates: clone<HackPartMediaObjectSubscription[] | undefined>(
 			part.hackListenToMediaObjectUpdates
 		),
@@ -705,7 +708,13 @@ export function convertPartialBlueprintMutablePartToCore(
 			blueprintId,
 		])
 	} else {
-		delete playoutUpdatePart.userEditOperations
+		delete playoutUpdatePart.userEditProperties
+	}
+
+	if ('segmentHeaderNotes' in updatePart) {
+		playoutUpdatePart.segmentHeaderNotes = updatePart.segmentHeaderNotes?.map((note) =>
+			wrapTranslatableMessageFromBlueprints(note, [blueprintId])
+		)
 	}
 
 	return playoutUpdatePart

packages/job-worker/src/ingest/generationSegment.ts

@@ -377,6 +377,9 @@ function updateModelWithGeneratedPart(
 					]),
 				}
 			: undefined,
+		segmentHeaderNotes: blueprintPart.part.segmentHeaderNotes?.map((note) =>
+			wrapTranslatableMessageFromBlueprints(note, [blueprintId])
+		),
 		userEditOperations: translateUserEditsFromBlueprint(blueprintPart.part.userEditOperations, [blueprintId]),
 		userEditProperties: translateUserEditPropertiesFromBlueprint(blueprintPart.part.userEditProperties, [
 			blueprintId,

packages/webui/src/client/ui/SegmentHeader/SegmentHeaderNotes.tsx

@@ -12,9 +12,10 @@ import { PartInstance } from '@sofie-automation/meteor-lib/dist/collections/Part
 import { literal } from 'shuttle-webhid'
 import { Notifications } from '../../collections'
 import { getIgnorePieceContentStatus } from '../../lib/localStorage'
-import { UISegmentPartNotes, UIPieceContentStatuses, UIPartInstances } from '../Collections'
+import { UISegmentPartNotes, UIPieceContentStatuses, UIPartInstances, UIParts } from '../Collections'
 import { useTracker } from '../../lib/ReactMeteorData/ReactMeteorData'
 import type { ITranslatableMessage } from '@sofie-automation/corelib/dist/TranslatableMessage'
+import type { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 
 export interface SegmentHeaderNotesProps {
 	/** Override the classname of the root div */
@@ -77,7 +78,7 @@ function getReactivePieceNoteCountsForSegment(segmentId: SegmentId): SegmentNote
 	const segmentNoteCounts: SegmentNoteCounts = {
 		criticalNotes: 0,
 		warningNotes: 0,
-		headerNotes: [], // TODO - define
+		headerNotes: [],
 	}
 
 	const rawNotes = UISegmentPartNotes.find({ segmentId }, { fields: { note: 1 } }).fetch() as Pick<
@@ -144,9 +145,15 @@ function getReactivePieceNoteCountsForSegment(segmentId: SegmentId): SegmentNote
 		{
 			fields: {
 				_id: 1,
+				// @ts-expect-error deep property
+				'part._id': 1,
+				'part._rank': 1,
+				'part.segmentHeaderNotes': 1,
 			},
 		}
-	).fetch() as Array<Pick<PartInstance, '_id'>>
+	).fetch() as Array<
+		Pick<PartInstance, '_id'> & { part: Pick<PartInstance['part'], '_id' | '_rank' | 'segmentHeaderNotes'> }
+	>
 	const rawNotifications = Notifications.find(
 		{
 			$or: [
@@ -179,5 +186,37 @@ function getReactivePieceNoteCountsForSegment(segmentId: SegmentId): SegmentNote
 		}
 	}
 
+	const partsForSegment = UIParts.find(
+		{ segmentId },
+		{
+			fields: {
+				_id: 1,
+				_rank: 1,
+				segmentHeaderNotes: 1,
+			},
+		}
+	).fetch() as Array<Pick<DBPart, '_id' | '_rank' | 'segmentHeaderNotes'>>
+
+	// Collect the segment header notes from the parts in part rank order, with partinstance taking priority over the part
+	const partIdsWithInstance = new Set(partInstancesForSegment.map((pi) => pi.part._id))
+
+	const mergedNoteEntries: Array<{ rank: number; notes: ITranslatableMessage[] }> = []
+	for (const partInstance of partInstancesForSegment) {
+		if (partInstance.part.segmentHeaderNotes?.length) {
+			mergedNoteEntries.push({ rank: partInstance.part._rank, notes: partInstance.part.segmentHeaderNotes })
+		}
+	}
+	for (const part of partsForSegment) {
+		if (partIdsWithInstance.has(part._id)) continue
+		if (part.segmentHeaderNotes?.length) {
+			mergedNoteEntries.push({ rank: part._rank, notes: part.segmentHeaderNotes })
+		}
+	}
+
+	mergedNoteEntries.sort((a, b) => a.rank - b.rank)
+	for (const entry of mergedNoteEntries) {
+		segmentNoteCounts.headerNotes.push(...entry.notes)
+	}
+
 	return segmentNoteCounts
 }