feat: Add getUpcomingParts to action context

So that an action can be taken based on what items may be coming up
(further ahead than the next part instance)

Author: rjmunro

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

@@ -1,3 +1,4 @@
+import { ReadonlyDeep } from 'type-fest'
 import {
 	IBlueprintMutatablePart,
 	IBlueprintPart,
@@ -48,6 +49,13 @@ export interface IPartAndPieceActionContext {
 	/** 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/context/OnTakeContext.ts

@@ -25,6 +25,7 @@ import { JobContext, ProcessedShowStyleCompound } from '../../jobs/index.js'
 import { executePeripheralDeviceAction, listPlayoutDevices } from '../../peripheralDevice.js'
 import { ActionPartChange, PartAndPieceInstanceActionService } from './services/PartAndPieceInstanceActionService.js'
 import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
+import { getOrderedPartsAfterPlayhead } from '../../playout/lookahead/util.js'
 
 export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContext, IEventContext {
 	public isTakeAborted: boolean
@@ -52,6 +53,10 @@ export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContex
 		this.isTakeAborted = false
 	}
 
+	async getUpcomingParts(limit: number = 5): Promise<ReadonlyDeep<IBlueprintPart[]>> {
+		return getOrderedPartsAfterPlayhead(this._context, this._playoutModel, limit)
+	}
+
 	abortTake(): void {
 		this.isTakeAborted = true
 	}

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

@@ -32,6 +32,7 @@ import { executePeripheralDeviceAction, listPlayoutDevices } from '../../periphe
 import { ActionPartChange, PartAndPieceInstanceActionService } from './services/PartAndPieceInstanceActionService.js'
 import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
 import { setNextPartFromPart } from '../../playout/setNext.js'
+import { getOrderedPartsAfterPlayhead } from '../../playout/lookahead/util.js'
 
 export class DatastoreActionExecutionContext
 	extends ShowStyleUserContext
@@ -102,6 +103,10 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 		super(contextInfo, _context, showStyle, watchedPackages)
 	}
 
+	async getUpcomingParts(limit: number = 5): Promise<ReadonlyDeep<IBlueprintPart[]>> {
+		return getOrderedPartsAfterPlayhead(this._context, this._playoutModel, limit)
+	}
+
 	async getPartInstance(part: 'current' | 'next'): Promise<IBlueprintPartInstance | undefined> {
 		return this.partAndPieceInstanceService.getPartInstance(part)
 	}