wip: api

Author: Julusian

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

@@ -48,6 +48,7 @@ import type { ExpectedPackage } from '../package'
 import type { ABResolverConfiguration } from '../abPlayback'
 import type { SofieIngestSegment } from '../ingest-types'
 import { PackageStatusMessage } from '@sofie-automation/shared-lib/dist/packageStatusMessages'
+import { BlueprintPlayoutPersistentStore } from '../context/playoutStore'
 
 export { PackageStatusMessage }
 
@@ -122,6 +123,7 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	 */
 	executeDataStoreAction?: (
 		context: IDataStoreActionExecutionContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		actionId: string,
 		userData: ActionUserData,
 		triggerMode?: string
@@ -130,12 +132,13 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	/** Execute an action defined by an IBlueprintActionManifest */
 	executeAction?: (
 		context: IActionExecutionContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		actionId: string,
 		userData: ActionUserData,
 		triggerMode: string | undefined,
-		privateData?: unknown,
-		publicData?: unknown,
-		actionOptions?: { [key: string]: any }
+		privateData: unknown | undefined,
+		publicData: unknown | undefined,
+		actionOptions: { [key: string]: any } | undefined
 	) => Promise<{ validationErrors: any } | void>
 
 	/** Generate adlib piece from ingest data */
@@ -204,21 +207,27 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	 * Called during a Take action.
 	 * Allows for part modification or aborting the take.
 	 */
-	onTake?: (context: IOnTakeContext) => Promise<void>
+	onTake?: (
+		context: IOnTakeContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>
+	) => Promise<void>
 	/** Called after a Take action */
 	onPostTake?: (context: IPartEventContext) => Promise<void>
 
 	/**
 	 * Called when a part is set as Next, including right after a Take.
 	 * Allows for part modification.
 	 */
-	onSetAsNext?: (context: IOnSetAsNextContext) => Promise<void>
+	onSetAsNext?: (
+		context: IOnSetAsNextContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>
+	) => Promise<void>
 
 	/** Called after the timeline has been generated, used to manipulate the timeline */
 	onTimelineGenerate?: (
 		context: ITimelineEventContext,
 		timeline: OnGenerateTimelineObj<TSR.TSRTimelineContent>[],
-		previousPersistentState: TimelinePersistentState | undefined,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		previousPartEndState: PartEndState | undefined,
 		resolvedPieces: IBlueprintResolvedPieceInstance[]
 	) => Promise<BlueprintResultTimeline>
@@ -229,7 +238,7 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	/** Called just before taking the next part. This generates some persisted data used by onTimelineGenerate to modify the timeline based on the previous part (eg, persist audio levels) */
 	getEndStateForPart?: (
 		context: IRundownContext,
-		previousPersistentState: TimelinePersistentState | undefined,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		partInstance: IBlueprintPartInstance,
 		resolvedPieces: IBlueprintResolvedPieceInstance[],
 		time: number
@@ -249,7 +258,6 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 
 export interface BlueprintResultTimeline {
 	timeline: OnGenerateTimelineObj<TSR.TSRTimelineContent>[]
-	persistentState: TimelinePersistentState
 }
 export interface BlueprintResultBaseline {
 	timelineObjects: TimelineObjectCoreExt<TSR.TSRTimelineContent>[]

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

@@ -0,0 +1,6 @@
+export interface BlueprintPlayoutPersistentStore<T = unknown> {
+	getAll(): Partial<T>
+	getKey<K extends keyof T>(k: K): T[K] | undefined
+	setKey<K extends keyof T>(k: K, v: T[K]): void
+	setAll(obj: T): void
+}