feat: GW config types in Blueprints

Author: olzzon

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

@@ -28,6 +28,8 @@ 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 { PlayoutGatewayConfig } from '@sofie-automation/shared-lib/dist/generated/PlayoutGatewayConfigTypes'
 
 export interface StudioBlueprintManifest<TRawConfig = IBlueprintConfig, TProcessedConfig = unknown>
 	extends BlueprintManifestBase {
@@ -149,7 +151,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 +172,10 @@ export interface BlueprintParentDeviceSettings {
 	options: Record<string, any>
 }
 
+export type BlueprintMosDeviceConfig = MosDeviceConfig
+
+export type BlueprintPlayoutGatewayConfig = PlayoutGatewayConfig
+
 export interface IStudioConfigPreset<TConfig = IBlueprintConfig> {
 	name: string
 

packages/scripts/schema-types.mjs

@@ -23,6 +23,7 @@ try {
 	})
 
 	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)
@@ -37,6 +38,7 @@ try {
 	})
 
 	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)
@@ -49,6 +51,7 @@ try {
 	})
 
 	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)
@@ -63,6 +66,7 @@ try {
 	})
 
 	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)

packages/shared-lib/src/generated/LiveStatusGatewayOptionsTypes.ts

@@ -0,0 +1,13 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run "yarn generate-schema-types" to regenerate this file.
+ */
+
+export interface LiveStatusGatewayConfig {
+	/**
+	 * Activate Debug Logging
+	 */
+	debugLogging?: boolean
+}

packages/shared-lib/src/generated/MosGatewayDevicesTypes.ts

@@ -0,0 +1,40 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run "yarn generate-schema-types" to regenerate this file.
+ */
+
+export interface MosDeviceConfig {
+	primary: {
+		id: string
+		host: string
+		dontUseQueryPort?: boolean
+		timeout?: number
+		heartbeatInterval?: number
+		ports?: {
+			lower: number
+			upper: number
+			query: number
+		}
+	}
+	secondary?: {
+		id: string
+		host: string
+		dontUseQueryPort?: boolean
+		timeout?: number
+		heartbeatInterval?: number
+		openMediaHotStandby?: boolean
+		ports?: {
+			lower: number
+			upper: number
+			query: number
+		}
+	}
+	statuses: MosDeviceStatusesConfig
+}
+export interface MosDeviceStatusesConfig {
+	enabled: boolean
+	sendInRehearsal?: boolean
+	onlySendPlay?: boolean
+}

packages/shared-lib/src/generated/MosGatewayOptionsTypes.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run "yarn generate-schema-types" to regenerate this file.
+ */
+
+export interface MosGatewayConfig {
+	mosId: string
+	debugLogging?: boolean
+	strict?: boolean
+	ports?: {
+		lower: number
+		upper: number
+		query: number
+	}
+}

packages/shared-lib/src/generated/PlayoutGatewayConfigTypes.ts

@@ -0,0 +1,34 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run "yarn generate-schema-types" to regenerate this file.
+ */
+
+export interface PlayoutGatewayConfig {
+	/**
+	 * Activate Debug Logging
+	 */
+	debugLogging?: boolean
+	debugState?: boolean
+	/**
+	 * Activate Multi-Threading
+	 */
+	multiThreading?: boolean
+	/**
+	 * Requires restart of Gateway to apply
+	 */
+	multiThreadedResolver?: boolean
+	/**
+	 * Requires restart of Gateway to apply
+	 */
+	useCacheWhenResolving?: boolean
+	/**
+	 * Report command timings on all commands
+	 */
+	reportAllCommands?: boolean
+	/**
+	 * Adjust resolve-time estimation
+	 */
+	estimateResolveTimeMultiplier?: number
+}