feat: add getUpcomingParts method to OnSetAsNextContext

For fetching upcoming parts from a blueprint

Author: rjmunro

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

@@ -11,6 +11,7 @@ import {
 	IShowStyleUserContext,
 } from '../index.js'
 import { BlueprintQuickLookInfo } from './quickLoopInfo.js'
+import { ReadonlyDeep } from 'type-fest'
 
 /**
  * Context in which 'current' is the part currently on air, and 'next' is the partInstance being set as Next
@@ -56,6 +57,13 @@ export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContex
 	/** Gets the Segment. This primarily allows for accessing metadata */
 	getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined>
 
+	/** Get a list of the upcoming Parts in the Rundown, in the order that they will be Taken
+	 *
+	 * @param limit The max number of parts returned. Default is 5.
+	 * @returns An array of Parts. If there is no next part, the array will be empty.
+	 */
+	getUpcomingParts(limit?: number): Promise<ReadonlyDeep<IBlueprintPart[]>>
+
 	/**
 	 * Creative actions
 	 */

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

@@ -6,17 +6,21 @@ import { JobContext, ProcessedShowStyleCompound } from '../../jobs/index.js'
 import { mock } from 'jest-mock-extended'
 import { PartAndPieceInstanceActionService } from '../context/services/PartAndPieceInstanceActionService.js'
 import { OnSetAsNextContext } from '../context/index.js'
+import { protectString } from '@sofie-automation/corelib/dist/protectedString'
+import { PartId, RundownId, SegmentId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 
 describe('Test blueprint api context', () => {
 	async function getTestee(setManually = false) {
 		const mockActionService = mock<PartAndPieceInstanceActionService>()
+		const mockPlayoutModel = mock<PlayoutModel>()
 		const context = new OnSetAsNextContext(
 			{
 				name: 'fakeContext',
 				identifier: 'action',
 			},
 			mock<JobContext>(),
-			mock<PlayoutModel>(),
+			mockPlayoutModel,
 			mock<ProcessedShowStyleCompound>(),
 			mock<WatchedPackagesHelper>(),
 			mockActionService,
@@ -26,6 +30,7 @@ describe('Test blueprint api context', () => {
 		return {
 			context,
 			mockActionService,
+			mockPlayoutModel,
 		}
 	}
 
@@ -100,6 +105,42 @@ describe('Test blueprint api context', () => {
 			expect(mockActionService.getPartForPreviousPiece).toHaveBeenCalledWith({ _id: 'pieceId' })
 		})
 
+		test('getUpcomingParts', async () => {
+			const { context, mockPlayoutModel } = await getTestee()
+
+			mockPlayoutModel.getAllOrderedParts.mockReturnValue(
+				mock([
+					{
+						_id: protectString<PartId>('part1'),
+						title: 'Part 1',
+						invalid: false,
+						floated: false,
+						_rank: 1,
+						rundownId: protectString<RundownId>('rundown1'),
+						externalId: 'ext1',
+						segmentId: protectString<SegmentId>('seg1'),
+						expectedDurationWithTransition: 1000,
+						userEditOperations: [],
+					} as DBPart,
+					{
+						_id: protectString<PartId>('part2'),
+						title: 'Part 2',
+						invalid: false,
+						floated: false,
+						_rank: 1,
+						rundownId: protectString<RundownId>('rundown1'),
+						externalId: 'ext1',
+						segmentId: protectString<SegmentId>('seg1'),
+						expectedDurationWithTransition: 1000,
+						userEditOperations: [],
+					} as unknown as DBPart,
+				])
+			)
+
+			const parts = await context.getUpcomingParts()
+			expect(parts.map((i) => i.title)).toEqual(['Part 1', 'Part 2'])
+		})
+
 		test('insertPiece', async () => {
 			const { context, mockActionService } = await getTestee()
 

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

@@ -26,6 +26,8 @@ import { protectString } from '@sofie-automation/corelib/dist/protectedString'
 import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 import { selectNewPartWithOffsets } from '../../playout/moveNextPart.js'
+import { getOrderedPartsAfterPlayhead } from '../../playout/lookahead/util.js'
+import { convertPartToBlueprints } from './lib.js'
 
 export class OnSetAsNextContext
 	extends ShowStyleUserContext
@@ -57,6 +59,10 @@ export class OnSetAsNextContext
 		return this.partAndPieceInstanceService.nextPartState
 	}
 
+	async getUpcomingParts(limit: number = 5): Promise<ReadonlyDeep<IBlueprintPart[]>> {
+		return getOrderedPartsAfterPlayhead(this.jobContext, this.playoutModel, limit).map(convertPartToBlueprints)
+	}
+
 	async getPartInstance(part: 'current' | 'next'): Promise<IBlueprintPartInstance<unknown> | undefined> {
 		return this.partAndPieceInstanceService.getPartInstance(part)
 	}