wip: allow blueprints to define

Author: Julusian

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

@@ -130,6 +130,8 @@ export interface BlueprintResultApplyStudioConfig {
 	/** Playout Mappings */
 	mappings: BlueprintMappings
 
+	/** Parent device settings */
+	parentDevices: Record<string, BlueprintParentDeviceSettings>
 	/** Playout-gateway subdevices */
 	playoutDevices: Record<string, TSR.DeviceOptionsAny>
 	/** Ingest-gateway subdevices, the types here depend on the gateway you use */
@@ -143,6 +145,14 @@ export interface BlueprintResultApplyStudioConfig {
 	/** Package Containers */
 	packageContainers?: Record<string, StudioPackageContainer>
 }
+export interface BlueprintParentDeviceSettings {
+	/**
+	 * User friendly name for the device
+	 */
+	name: string
+
+	options: Record<string, any>
+}
 
 export interface IStudioConfigPreset<TConfig = IBlueprintConfig> {
 	name: string

packages/corelib/src/dataModel/Studio.ts

@@ -15,7 +15,6 @@ import {
 	StudioAbPlayerDisabling,
 } from '@sofie-automation/shared-lib/dist/core/model/StudioRouteSet'
 import { StudioPackageContainer } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
-import { GenericPeripheralDeviceSettings } from '@sofie-automation/shared-lib/dist/core/model/peripheralDevice'
 
 export { MappingsExt, MappingExt, MappingsHash }
 
@@ -197,5 +196,5 @@ export interface StudioDeviceSettings {
 	 */
 	name: string
 
-	options: GenericPeripheralDeviceSettings
+	options: unknown
 }

packages/job-worker/src/playout/upgrade.ts

@@ -1,12 +1,14 @@
 import {
 	BlueprintMapping,
 	BlueprintMappings,
+	BlueprintParentDeviceSettings,
 	JSONBlobParse,
 	StudioRouteBehavior,
 	TSR,
 } from '@sofie-automation/blueprints-integration'
 import {
 	MappingsExt,
+	StudioDeviceSettings,
 	StudioIngestDevice,
 	StudioInputDevice,
 	StudioPackageContainer,
@@ -49,6 +51,15 @@ export async function handleBlueprintUpgradeForStudio(context: JobContext, _data
 		compileCoreConfigValues(context.studio.settings)
 	)
 
+	const parentDevices = Object.fromEntries(
+		Object.entries<BlueprintParentDeviceSettings>(result.parentDevices ?? {}).map((dev) => [
+			dev[0],
+			literal<Complete<StudioDeviceSettings>>({
+				name: dev[1].name ?? '',
+				options: dev[1],
+			}),
+		])
+	)
 	const playoutDevices = Object.fromEntries(
 		Object.entries<TSR.DeviceOptionsAny>(result.playoutDevices ?? {}).map((dev) => [
 			dev[0],
@@ -112,6 +123,7 @@ export async function handleBlueprintUpgradeForStudio(context: JobContext, _data
 	await context.directCollections.Studios.update(context.studioId, {
 		$set: {
 			'mappingsWithOverrides.defaults': translateMappings(result.mappings),
+			'peripheralDeviceSettings.deviceSettings.defaults': parentDevices,
 			'peripheralDeviceSettings.playoutDevices.defaults': playoutDevices,
 			'peripheralDeviceSettings.ingestDevices.defaults': ingestDevices,
 			'peripheralDeviceSettings.inputDevices.defaults': inputDevices,

packages/shared-lib/src/core/model/peripheralDevice.ts

@@ -1,8 +1,6 @@
 import { TSR } from '../../tsr'
 import { PeripheralDeviceId, StudioId } from './Ids'
 
-export type GenericPeripheralDeviceSettings = Record<string, never>
-
 export interface IngestDeviceSecretSettingsStatus {
 	/** OAuth: Set to true when secret value exists */
 	credentials?: boolean