Merge pull request Sofie-Automation#1387 from bbc/upstream/gw-types-for-blueprints

Gateway types available for blueprints

Author: nytamin

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

@@ -28,6 +28,10 @@ import type {
 } from '@sofie-automation/shared-lib/dist/core/model/StudioRouteSet'
 import type { StudioPackageContainer } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
 import type { IStudioSettings } from '@sofie-automation/shared-lib/dist/core/model/StudioSettings'
+import type { MosDeviceConfig } from '@sofie-automation/shared-lib/dist/generated/MosGatewayDevicesTypes'
+import type { MosGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/MosGatewayOptionsTypes'
+import type { PlayoutGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/PlayoutGatewayConfigTypes'
+import type { LiveStatusGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/LiveStatusGatewayOptionsTypes'
 
 export interface StudioBlueprintManifest<TRawConfig = IBlueprintConfig, TProcessedConfig = unknown>
 	extends BlueprintManifestBase {
@@ -149,7 +153,7 @@ export interface BlueprintResultApplyStudioConfig {
 	/** Playout-gateway subdevices */
 	playoutDevices: Record<string, TSR.DeviceOptionsAny>
 	/** Ingest-gateway subdevices, the types here depend on the gateway you use */
-	ingestDevices: Record<string, unknown>
+	ingestDevices: Record<string, BlueprintMosDeviceConfig | unknown>
 	/** Input-gateway subdevices */
 	inputDevices: Record<string, unknown>
 	/** Route Sets */
@@ -170,6 +174,14 @@ export interface BlueprintParentDeviceSettings {
 	options: Record<string, any>
 }
 
+export type BlueprintMosGatewayConfig = MosGatewayConfig
+
+export type BlueprintMosDeviceConfig = MosDeviceConfig
+
+export type BlueprintPlayoutGatewayConfig = PlayoutGatewayConfig
+
+export type BlueprintLiveStatusGatewayConfig = LiveStatusGatewayConfig
+
 export interface IStudioConfigPreset<TConfig = IBlueprintConfig> {
 	name: string
 

packages/live-status-gateway/src/coreHandler.ts

@@ -23,7 +23,7 @@ import { protectString } from '@sofie-automation/shared-lib/dist/lib/protectedSt
 import { PeripheralDeviceCommandId, StudioId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
 import { StatusCode } from '@sofie-automation/shared-lib/dist/lib/status'
 import { PeripheralDeviceCommand } from '@sofie-automation/shared-lib/dist/core/model/PeripheralDeviceCommand'
-import { LiveStatusGatewayConfig } from './generated/options'
+import { LiveStatusGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/LiveStatusGatewayOptionsTypes'
 import { CorelibPubSubTypes, CorelibPubSubCollections } from '@sofie-automation/corelib/dist/pubsub'
 import { ParametersOfFunctionOrNever } from '@sofie-automation/server-core-integration/dist/lib/subscriptions'
 

packages/mos-gateway/src/mosHandler.ts

@@ -32,8 +32,8 @@ import {
 	DEFAULT_MOS_TIMEOUT_TIME,
 	DEFAULT_MOS_HEARTBEAT_INTERVAL,
 } from '@sofie-automation/shared-lib/dist/core/constants'
-import { MosGatewayConfig } from './generated/options'
-import { MosDeviceConfig } from './generated/devices'
+import { MosGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/MosGatewayOptionsTypes'
+import { MosDeviceConfig } from '@sofie-automation/shared-lib/dist/generated/MosGatewayDevicesTypes'
 import { PeripheralDeviceForDevice } from '@sofie-automation/server-core-integration'
 
 export interface MosConfig {

packages/playout-gateway/src/coreHandler.ts

@@ -23,7 +23,7 @@ import { PLAYOUT_DEVICE_CONFIG } from './configManifest'
 import { BaseRemoteDeviceIntegration } from 'timeline-state-resolver/dist/service/remoteDeviceInstance'
 import { getVersions } from './versions'
 import { CoreConnectionChild } from '@sofie-automation/server-core-integration/dist/lib/CoreConnectionChild'
-import { PlayoutGatewayConfig } from './generated/options'
+import { PlayoutGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/PlayoutGatewayConfigTypes'
 import { PeripheralDeviceCommandId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
 
 export interface CoreConfig {

packages/playout-gateway/src/tsrHandler.ts

@@ -37,7 +37,7 @@ import {
 	TimelineObjGeneric,
 } from '@sofie-automation/shared-lib/dist/core/model/Timeline'
 import { PLAYOUT_DEVICE_CONFIG } from './configManifest'
-import { PlayoutGatewayConfig } from './generated/options'
+import { PlayoutGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/PlayoutGatewayConfigTypes'
 import {
 	assertNever,
 	getSchemaDefaultValues,

packages/scripts/schema-types.mjs

@@ -22,7 +22,7 @@ try {
 		bannerComment: '',
 	})
 
-	await fs.writeFile('./playout-gateway/src/generated/options.ts', BANNER + '\n' + schema)
+	await fs.writeFile('./shared-lib/src/generated/PlayoutGatewayConfigTypes.ts', BANNER + '\n' + schema)
 } catch (e) {
 	console.error('Error while generating playout-gateway options.json, continuing...')
 	console.error(e)
@@ -36,7 +36,7 @@ try {
 		bannerComment: '',
 	})
 
-	await fs.writeFile('./mos-gateway/src/generated/options.ts', BANNER + '\n' + schema)
+	await fs.writeFile('./shared-lib/src/generated/MosGatewayOptionsTypes.ts', BANNER + '\n' + schema)
 } catch (e) {
 	console.error('Error while generating mos-gateway options.json, continuing...')
 	console.error(e)
@@ -48,7 +48,7 @@ try {
 		bannerComment: '',
 	})
 
-	await fs.writeFile('./mos-gateway/src/generated/devices.ts', BANNER + '\n' + schema)
+	await fs.writeFile('./shared-lib/src/generated/MosGatewayDevicesTypes.ts', BANNER + '\n' + schema)
 } catch (e) {
 	console.error('Error while generating mos-gateway devices.json, continuing...')
 	console.error(e)
@@ -62,7 +62,7 @@ try {
 		bannerComment: '',
 	})
 
-	await fs.writeFile('./live-status-gateway/src/generated/options.ts', BANNER + '\n' + schema)
+	await fs.writeFile('./shared-lib/src/generated/LiveStatusGatewayOptionsTypes.ts', BANNER + '\n' + schema)
 } catch (e) {
 	console.error('Error while generating live-status-gateway options.json, continuing...')
 	console.error(e)