Merge branch 'upstream/release53' into bbc-release53

Author: Julusian

meteor/Dockerfile

@@ -30,6 +30,8 @@ COPY meteor /opt/core/meteor
 COPY scripts /opt/core/scripts
 WORKDIR /opt/core/meteor
 
+# remove the dev only assets from the webui output
+RUN rm -Rf /opt/core/packages/webui/dist/dev
 # move the webui to the correct place
 RUN rm -Rf /opt/core/meteor/public
 RUN cp -R /opt/core/packages/webui/dist /opt/core/meteor/public

meteor/server/api/rest/v1/typeConversion.ts

@@ -388,6 +388,7 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Comple
 		allowPieceDirectPlay: apiStudioSettings.allowPieceDirectPlay ?? true, // Backwards compatible
 		enableBuckets: apiStudioSettings.enableBuckets ?? true, // Backwards compatible
 		enableEvaluationForm: apiStudioSettings.enableEvaluationForm ?? true, // Backwards compatible
+		mockPieceContentStatus: apiStudioSettings.mockPieceContentStatus,
 		rundownGlobalPiecesPrepareTime: apiStudioSettings.rundownGlobalPiecesPrepareTime,
 	}
 }
@@ -414,6 +415,7 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APISt
 		allowPieceDirectPlay: settings.allowPieceDirectPlay,
 		enableBuckets: settings.enableBuckets,
 		enableEvaluationForm: settings.enableEvaluationForm,
+		mockPieceContentStatus: settings.mockPieceContentStatus,
 		rundownGlobalPiecesPrepareTime: settings.rundownGlobalPiecesPrepareTime,
 	}
 }

meteor/server/lib/rest/v1/studios.ts

@@ -222,5 +222,6 @@ export interface APIStudioSettings {
 	allowPieceDirectPlay?: boolean
 	enableBuckets?: boolean
 	enableEvaluationForm?: boolean
+	mockPieceContentStatus?: boolean
 	rundownGlobalPiecesPrepareTime?: number
 }

meteor/server/publications/pieceContentStatusUI/checkPieceContentStatus.ts

@@ -225,6 +225,27 @@ export async function checkPieceContentStatusAndDependencies(
 		packageContainerPackageStatuses: [],
 	}
 
+	if (studio.settings.mockPieceContentStatus) {
+		return [
+			{
+				status: PieceStatusCode.OK,
+				messages: [],
+				progress: undefined,
+
+				freezes: [],
+				blacks: [],
+				scenes: [],
+
+				thumbnailUrl: undefined,
+				previewUrl: '/dev/fakePreview.mp4',
+
+				packageName: null,
+				contentDuration: 30 * 1000,
+			},
+			pieceDependencies,
+		]
+	}
+
 	const ignoreMediaStatus = piece.content && piece.content.ignoreMediaObjectStatus
 	if (!ignoreMediaStatus) {
 		if (piece.expectedPackages) {

packages/blueprints-integration/src/content.ts

@@ -2,6 +2,7 @@ import { JSONBlob } from '@sofie-automation/shared-lib/dist/lib/JSONBlob'
 import { Time } from './common'
 import { TSR, TimelineObjectCoreExt } from './timeline'
 import { SourceLayerType } from '@sofie-automation/shared-lib/dist/core/model/ShowStyle'
+import { PopupPreview } from './previews'
 
 export type WithTimeline<T extends BaseContent> = T & {
 	timelineObjects: TimelineObjectCoreExt<TSR.TSRTimelineContent>[]
@@ -19,6 +20,11 @@ export interface BaseContent {
 	ignoreBlackFrames?: boolean
 	ignoreFreezeFrame?: boolean
 	ignoreAudioFormat?: boolean
+
+	/**
+	 * Overwrite any default hover previews in Sofie
+	 */
+	popUpPreview?: PopupPreview
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

packages/blueprints-integration/src/index.ts

@@ -21,6 +21,7 @@ export * from './util'
 export * from './translations'
 export * from './triggers'
 export * from './userEditing'
+export * from './previews'
 
 export { MOS } from '@sofie-automation/shared-lib/dist/mos'
 

packages/blueprints-integration/src/previews.ts

@@ -0,0 +1,78 @@
+import { SplitsContentBoxContent, SplitsContentBoxProperties } from './content'
+import { NoteSeverity } from './lib'
+import { ITranslatableMessage } from './translations'
+
+export interface PopupPreview<P extends Previews = Previews> {
+	name?: string
+	preview?: P
+	warnings?: InvalidPreview[]
+}
+export type Previews = TablePreview | ScriptPreview | HTMLPreview | SplitPreview | VTPreview | BlueprintImagePreview
+
+export enum PreviewType {
+	Invalid = 'invalid',
+	Table = 'table',
+	Script = 'script',
+	HTML = 'html',
+	Split = 'split',
+	VT = 'vt',
+	BlueprintImage = 'blueprintImage',
+}
+
+interface PreviewBase {
+	type: PreviewType
+}
+
+export interface InvalidPreview extends PreviewBase {
+	type: PreviewType.Invalid
+
+	severity: NoteSeverity
+	reason: ITranslatableMessage
+}
+export interface TablePreview extends PreviewBase {
+	type: PreviewType.Table
+
+	entries: { key: string; value: string }[]
+	displayTiming: boolean
+}
+export interface ScriptPreview extends PreviewBase {
+	type: PreviewType.Script
+
+	fullText?: string
+	lastWords?: string
+	comment?: string
+	lastModified?: number
+}
+export interface HTMLPreview extends PreviewBase {
+	// todo - expose if and how steps can be controlled
+	type: PreviewType.HTML
+
+	name?: string
+
+	previewUrl: string
+	previewDimension?: { width: number; height: number }
+
+	postMessageOnLoad?: any
+
+	steps?: { current: number; total: number }
+}
+export interface SplitPreview extends PreviewBase {
+	type: PreviewType.Split
+
+	background?: string // file asset upload?
+	boxes: (SplitsContentBoxContent & SplitsContentBoxProperties)[]
+}
+export interface VTPreview extends PreviewBase {
+	type: PreviewType.VT
+
+	// note: the info required for the preview follows from package manager so there's nothing for blueprins here
+	// note: if we want to allow a preview for different media than saved on the piece (because perhaps the media is in a non-primary piece) should we allow to specifiy the package to preview?
+
+	inWords?: string // note - only displayed if outWords are present
+	outWords?: string
+}
+export interface BlueprintImagePreview extends PreviewBase {
+	type: PreviewType.BlueprintImage
+
+	image: string // to be put in as asset
+}

packages/corelib/src/lib.ts

@@ -8,6 +8,7 @@ import { iterateDeeply, iterateDeeplyEnum, Time } from '@sofie-automation/bluepr
 import { IStudioSettings } from './dataModel/Studio'
 import { customAlphabet as createNanoid } from 'nanoid'
 import type { ITranslatableMessage } from './TranslatableMessage'
+import { ReadonlyObjectDeep } from 'type-fest/source/readonly-deep'
 
 /**
  * Limited character set to use for id generation
@@ -63,6 +64,10 @@ export function clone<T>(o: ReadonlyDeep<T> | Readonly<T> | T): T {
 	// Use this instead of fast-clone directly, as this retains the type
 	return fastClone(o as any)
 }
+export function cloneObject<T extends object>(o: ReadonlyObjectDeep<T> | Readonly<T> | T): T {
+	// Use this instead of fast-clone directly, as this retains the type
+	return fastClone(o as any)
+}
 
 /**
  * Deeply freeze an object

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

@@ -21,7 +21,7 @@ import {
 	CoreUserEditingDefinitionSofie,
 } from '@sofie-automation/corelib/dist/dataModel/UserEditingDefinitions'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
-import { assertNever, clone, Complete, literal, omit } from '@sofie-automation/corelib/dist/lib'
+import { assertNever, clone, cloneObject, Complete, literal, omit } from '@sofie-automation/corelib/dist/lib'
 import { unprotectString, unprotectStringArray } from '@sofie-automation/corelib/dist/protectedString'
 import { ReadonlyDeep } from 'type-fest'
 import {
@@ -231,7 +231,7 @@ function convertPieceGenericToBlueprintsInner(piece: ReadonlyDeep<PieceGeneric>)
 		expectedPackages: clone<ExpectedPackage.Any[] | undefined>(piece.expectedPackages),
 		hasSideEffects: piece.hasSideEffects,
 		content: {
-			...clone(piece.content),
+			...cloneObject(piece.content),
 			timelineObjects: deserializePieceTimelineObjectsBlob(piece.timelineObjectsString),
 		},
 		abSessions: clone<PieceAbSessionInfo[] | undefined>(piece.abSessions),

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

@@ -44,7 +44,7 @@ function generateExpectedMediaItems<T extends ExpectedMediaItemBase>(
 	commonProps: Subtract<T, ExpectedMediaItemBase>,
 	studioId: StudioId,
 	label: string,
-	content: Partial<SomeContent> | undefined,
+	content: Partial<SomeContent | ReadonlyDeep<SomeContent>> | undefined,
 	pieceType: string
 ): T[] {
 	const result: T[] = []