feat: support expressions for most internal action fields #2345 (#3617)

Author: Julusian

companion/lib/Controls/Controller.ts

@@ -30,7 +30,7 @@ import { createActionSetsTrpcRouter } from './ActionSetsTrpcRouter.js'
 import { createControlsTrpcRouter } from './ControlsTrpcRouter.js'
 import z from 'zod'
 import type { SomeControlModel, UIControlUpdate } from '@companion-app/shared/Model/Controls.js'
-import type { VariableValues } from '@companion-app/shared/Model/Variables.js'
+import type { VariableValue, VariableValues } from '@companion-app/shared/Model/Variables.js'
 import type { VariablesAndExpressionParser } from '../Variables/VariablesAndExpressionParser.js'
 import { ControlExpressionVariable } from './ControlTypes/ExpressionVariable.js'
 import type {
@@ -41,6 +41,7 @@ import { ExpressionVariableCollections } from './ExpressionVariableCollections.j
 import { createExpressionVariableTrpcRouter } from './ExpressionVariableTrpcRouter.js'
 import { ExpressionVariableNameMap } from './ExpressionVariableNameMap.js'
 import { ControlButtonPreset } from './ControlTypes/Button/Preset.js'
+import type { CompanionFeedbackButtonStyleResult } from '@companion-module/host'
 
 /**
  * The class that manages the controls
@@ -766,5 +767,5 @@ export class ControlsController {
 export interface NewFeedbackValue {
 	id: string
 	controlId: string
-	value: any
+	value: CompanionFeedbackButtonStyleResult | VariableValue
 }

companion/lib/Instance/Connection/ChildHandlerLegacy.ts

@@ -753,6 +753,7 @@ export class ConnectionChildHandlerLegacy implements ChildProcessHandlerBase, Co
 
 				feedbackType: null,
 				feedbackStyle: undefined,
+				optionsSupportExpressions: false, // Expressions not supported from 1.x modules
 			} satisfies Complete<ClientEntityDefinition>
 		}
 
@@ -789,6 +790,7 @@ export class ConnectionChildHandlerLegacy implements ChildProcessHandlerBase, Co
 
 				showButtonPreview: false,
 				supportsChildGroups: [],
+				optionsSupportExpressions: false, // Expressions not supported from 1.x modules
 			} satisfies Complete<ClientEntityDefinition>
 		}
 

companion/lib/Instance/Connection/ConfigFieldsLegacy.ts

@@ -146,9 +146,11 @@ function translateTextInputField(
 	usesInternalVariableParsing: boolean
 ): Complete<CompanionInputFieldTextInputExtended> {
 	let useVariables: CompanionFieldVariablesSupport | undefined
-	if (field.useVariables) {
+	if (usesInternalVariableParsing) {
+		useVariables = { local: true }
+	} else if (field.useVariables) {
 		useVariables = {
-			local: usesInternalVariableParsing || (typeof field.useVariables === 'object' && field.useVariables.local),
+			local: typeof field.useVariables === 'object' && field.useVariables.local,
 		}
 	}
 
@@ -254,13 +256,18 @@ function translateCustomVariableField(
 
 function translateCommonFields(
 	field: EncodeIsVisible<CompanionInputFieldBase>
-): Pick<Complete<CompanionInputFieldBaseExtended>, 'id' | 'label' | 'tooltip' | 'description' | 'isVisibleUi'> {
+): Pick<
+	Complete<CompanionInputFieldBaseExtended>,
+	'id' | 'label' | 'tooltip' | 'description' | 'expressionDescription' | 'isVisibleUi' | 'disableAutoExpression'
+> {
 	return {
 		id: field.id,
 		label: field.label,
 		tooltip: field.tooltip,
 		description: field.description,
+		expressionDescription: undefined, // Expressions not supported from 1.x modules
 		isVisibleUi: translateIsVisibleFn(field),
+		disableAutoExpression: true, // Expressions not supported from 1.x modules
 	}
 }
 

companion/lib/Instance/Connection/Thread/ConfigFields.ts

@@ -240,18 +240,23 @@ function translateCustomVariableField(
 
 function translateCommonFields(
 	field: CompanionInputFieldBase
-): Pick<Complete<CompanionInputFieldBaseExtended>, 'id' | 'label' | 'tooltip' | 'description' | 'isVisibleUi'> {
+): Pick<
+	Complete<CompanionInputFieldBaseExtended>,
+	'id' | 'label' | 'tooltip' | 'description' | 'expressionDescription' | 'isVisibleUi' | 'disableAutoExpression'
+> {
 	return {
 		id: field.id,
 		label: field.label,
 		tooltip: field.tooltip,
 		description: field.description,
+		expressionDescription: undefined, // Temporary until #2345
 		isVisibleUi: field.isVisibleExpression
 			? {
 					type: 'expression',
 					fn: field.isVisibleExpression,
 					data: undefined,
 				}
 			: undefined,
+		disableAutoExpression: true, // Temporary until #2345
 	}
 }

companion/lib/Instance/Connection/Thread/HostContext.ts

@@ -70,6 +70,8 @@ export class HostContext<TConfig, TSecrets> implements ModuleHostContext<TConfig
 
 				feedbackType: null,
 				feedbackStyle: undefined,
+
+				optionsSupportExpressions: false, // Future: follow up to enable for modules!
 			} satisfies Complete<ClientEntityDefinition>
 		}
 
@@ -97,6 +99,8 @@ export class HostContext<TConfig, TSecrets> implements ModuleHostContext<TConfig
 
 				showButtonPreview: false,
 				supportsChildGroups: [],
+
+				optionsSupportExpressions: false, // Future: follow up to enable for modules!
 			} satisfies Complete<ClientEntityDefinition>
 		}
 

companion/lib/Instance/Definitions.ts

@@ -28,6 +28,7 @@ import { EventEmitter } from 'node:events'
 import type { InstanceConfigStore } from './ConfigStore.js'
 import { ModuleInstanceType } from '@companion-app/shared/Model/Instance.js'
 import { ConvertPresetStyleToDrawStyle } from './Connection/Thread/Presets.js'
+import type { ExpressionOrValue } from '@companion-app/shared/Model/Options.js'
 
 type InstanceDefinitionsEvents = {
 	readonly updatePresets: [connectionId: string]
@@ -151,7 +152,15 @@ export class InstanceDefinitions extends EventEmitter<InstanceDefinitionsEvents>
 
 		if (definition.options !== undefined && definition.options.length > 0) {
 			for (const opt of definition.options) {
-				entity.options[opt.id] = structuredClone((opt as any).default)
+				const defaultValue = structuredClone((opt as any).default)
+				if (definition.optionsSupportExpressions && !opt.disableAutoExpression) {
+					entity.options[opt.id] = {
+						isExpression: false,
+						value: defaultValue,
+					} satisfies ExpressionOrValue<any>
+				} else {
+					entity.options[opt.id] = defaultValue
+				}
 			}
 		}
 

companion/lib/Instance/Surface/Thread/ConfigFields.ts

@@ -113,7 +113,14 @@ function translateCommonFields(
 	field: CompanionInputFieldBase
 ): Pick<
 	Complete<CompanionInputFieldBaseExtended>,
-	'id' | 'label' | 'tooltip' | 'description' | 'isVisibleUi' | 'width'
+	| 'id'
+	| 'label'
+	| 'tooltip'
+	| 'description'
+	| 'expressionDescription'
+	| 'isVisibleUi'
+	| 'width'
+	| 'disableAutoExpression'
 > {
 	return {
 		id: field.id,
@@ -127,6 +134,9 @@ function translateCommonFields(
 					data: undefined,
 				}
 			: undefined,
+		// Note valid for surface configs:
+		expressionDescription: undefined,
 		width: undefined,
+		disableAutoExpression: true,
 	}
 }