Merge pull request #1393 from bbc/feat/expose-segment-metadata

feat(Blueprint API): Expose Segments in blueprint contexts

Author: jstarpl

packages/blueprints-integration/src/context/onSetAsNextContext.ts

@@ -6,6 +6,7 @@ import {
 	IBlueprintPieceDB,
 	IBlueprintPieceInstance,
 	IBlueprintResolvedPieceInstance,
+	IBlueprintSegment,
 	IEventContext,
 	IShowStyleUserContext,
 } from '..'
@@ -49,6 +50,8 @@ export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContex
 	getPartInstanceForPreviousPiece(piece: IBlueprintPieceInstance): Promise<IBlueprintPartInstance>
 	/** Gets the Part for a Piece retrieved from findLastScriptedPieceOnLayer. This primarily allows for accessing metadata of the Part */
 	getPartForPreviousPiece(piece: IBlueprintPieceDB): Promise<IBlueprintPart | undefined>
+	/** Gets the Segment. This primarily allows for accessing metadata */
+	getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined>
 
 	/**
 	 * Creative actions

packages/blueprints-integration/src/context/partsAndPieceActionContext.ts

@@ -6,6 +6,7 @@ import {
 	IBlueprintPieceDB,
 	IBlueprintPieceInstance,
 	IBlueprintResolvedPieceInstance,
+	IBlueprintSegment,
 	Time,
 } from '..'
 import { BlueprintQuickLookInfo } from './quickLoopInfo'
@@ -44,6 +45,8 @@ export interface IPartAndPieceActionContext {
 	getPartInstanceForPreviousPiece(piece: IBlueprintPieceInstance): Promise<IBlueprintPartInstance>
 	/** Gets the Part for a Piece retrieved from findLastScriptedPieceOnLayer. This primarily allows for accessing metadata of the Part */
 	getPartForPreviousPiece(piece: IBlueprintPieceDB): Promise<IBlueprintPart | undefined>
+	/** Gets the Segment. This primarily allows for accessing metadata */
+	getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined>
 
 	/**
 	 * Creative actions

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

@@ -53,6 +53,14 @@ describe('Test blueprint api context', () => {
 			expect(mockActionService.getResolvedPieceInstances).toHaveBeenCalledWith('current')
 		})
 
+		test('getSegment', async () => {
+			const { context, mockActionService } = await getTestee()
+
+			await context.getSegment('current')
+			expect(mockActionService.getSegment).toHaveBeenCalledTimes(1)
+			expect(mockActionService.getSegment).toHaveBeenCalledWith('current')
+		})
+
 		test('findLastPieceOnLayer', async () => {
 			const { context, mockActionService } = await getTestee()
 

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

@@ -53,6 +53,14 @@ describe('Test blueprint api context', () => {
 			expect(mockActionService.getResolvedPieceInstances).toHaveBeenCalledWith('current')
 		})
 
+		test('getSegment', async () => {
+			const { context, mockActionService } = await getTestee()
+
+			await context.getSegment('current')
+			expect(mockActionService.getSegment).toHaveBeenCalledTimes(1)
+			expect(mockActionService.getSegment).toHaveBeenCalledWith('current')
+		})
+
 		test('findLastPieceOnLayer', async () => {
 			const { context, mockActionService } = await getTestee()
 

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

@@ -55,6 +55,14 @@ describe('Test blueprint api context', () => {
 			expect(mockActionService.getResolvedPieceInstances).toHaveBeenCalledWith('current')
 		})
 
+		test('getSegment', async () => {
+			const { context, mockActionService } = await getTestee()
+
+			await context.getSegment('current')
+			expect(mockActionService.getSegment).toHaveBeenCalledTimes(1)
+			expect(mockActionService.getSegment).toHaveBeenCalledWith('current')
+		})
+
 		test('findLastPieceOnLayer', async () => {
 			const { context, mockActionService } = await getTestee()
 

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

@@ -9,6 +9,7 @@ import {
 	IBlueprintPieceDB,
 	IBlueprintPieceInstance,
 	IBlueprintResolvedPieceInstance,
+	IBlueprintSegment,
 	IEventContext,
 	IOnSetAsNextContext,
 } from '@sofie-automation/blueprints-integration'
@@ -67,6 +68,10 @@ export class OnSetAsNextContext
 		return this.partAndPieceInstanceService.getResolvedPieceInstances(part)
 	}
 
+	async getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined> {
+		return this.partAndPieceInstanceService.getSegment(segment)
+	}
+
 	async findLastPieceOnLayer(
 		sourceLayerId0: string | string[],
 		options?: {

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

@@ -12,6 +12,7 @@ import {
 	TSR,
 	IBlueprintPlayoutDevice,
 	IOnTakeContext,
+	IBlueprintSegment,
 } from '@sofie-automation/blueprints-integration'
 import { PeripheralDeviceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { ReadonlyDeep } from 'type-fest'
@@ -64,6 +65,9 @@ export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContex
 	async getResolvedPieceInstances(part: 'current' | 'next'): Promise<IBlueprintResolvedPieceInstance[]> {
 		return this.partAndPieceInstanceService.getResolvedPieceInstances(part)
 	}
+	async getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined> {
+		return this.partAndPieceInstanceService.getSegment(segment)
+	}
 
 	async findLastPieceOnLayer(
 		sourceLayerId0: string | string[],

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

@@ -14,6 +14,7 @@ import {
 	TSR,
 	IBlueprintPlayoutDevice,
 	StudioRouteSet,
+	IBlueprintSegment,
 } from '@sofie-automation/blueprints-integration'
 import { PartInstanceId, PeripheralDeviceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { ReadonlyDeep } from 'type-fest'
@@ -113,6 +114,10 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 		return this.partAndPieceInstanceService.getResolvedPieceInstances(part)
 	}
 
+	async getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined> {
+		return this.partAndPieceInstanceService.getSegment(segment)
+	}
+
 	async findLastPieceOnLayer(
 		sourceLayerId0: string | string[],
 		options?: {

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

@@ -9,6 +9,7 @@ import {
 	IBlueprintPieceDB,
 	IBlueprintPieceInstance,
 	IBlueprintResolvedPieceInstance,
+	IBlueprintSegment,
 	OmitId,
 	SomeContent,
 	Time,
@@ -22,6 +23,7 @@ import {
 	convertPieceInstanceToBlueprints,
 	convertPieceToBlueprints,
 	convertResolvedPieceInstanceToBlueprints,
+	convertSegmentToBlueprints,
 	createBlueprintQuickLoopInfo,
 	getMediaObjectDuration,
 } from '../lib'
@@ -138,6 +140,14 @@ export class PartAndPieceInstanceActionService {
 		)
 		return resolvedInstances.map(convertResolvedPieceInstanceToBlueprints)
 	}
+	getSegment(segment: 'current' | 'next'): IBlueprintSegment | undefined {
+		const partInstance = this.#getPartInstance(segment)
+		if (!partInstance) return undefined
+
+		const segmentModel = this._playoutModel.findSegment(partInstance.partInstance.segmentId)
+
+		return segmentModel?.segment ? convertSegmentToBlueprints(segmentModel?.segment) : undefined
+	}
 
 	async findLastPieceOnLayer(
 		sourceLayerId0: string | string[],