feat: rework control entities

companion/lib/Controls/ActionRecorder.ts

@@ -6,12 +6,13 @@ import LogController from '../Log/Controller.js'
 import { EventEmitter } from 'events'
 import type { Registry } from '../Registry.js'
 import type {
-	RecordActionTmp,
+	RecordActionEntityModel,
 	RecordSessionInfo,
 	RecordSessionListInfo,
 } from '@companion-app/shared/Model/ActionRecorderModel.js'
 import type { ClientSocket } from '../UI/Handler.js'
 import type { ActionSetId } from '@companion-app/shared/Model/ActionModel.js'
+import { EntityModelType, SomeSocketEntityLocation } from '@companion-app/shared/Model/EntityModel.js'
 
 const SessionListRoom = 'action-recorder:session-list'
 function SessionRoom(id: string): string {
@@ -356,10 +357,11 @@ export class ActionRecorder extends EventEmitter<ActionRecorderEvents> {
 			const session = this.#currentSession
 
 			if (session.connectionIds.includes(connectionId)) {
-				const newAction: RecordActionTmp = {
+				const newAction: RecordActionEntityModel = {
+					type: EntityModelType.Action,
 					id: nanoid(),
-					instance: connectionId,
-					action: actionId,
+					connectionId: connectionId,
+					definitionId: actionId,
 					options: options,
 					delay: (session.actionDelay ?? 0) + delay,
 
@@ -395,14 +397,16 @@ export class ActionRecorder extends EventEmitter<ActionRecorderEvents> {
 		if (!control) throw new Error(`Unknown control: ${controlId}`)
 
 		if (mode === 'append') {
-			if (control.supportsActions) {
-				if (!control.actionAppend(stepId, setId, this.#currentSession.actions, null)) throw new Error('Unknown set')
+			if (control.supportsEntities) {
+				if (!control.entities.entityAdd({ stepId, setId }, null, ...this.#currentSession.actions))
+					throw new Error('Unknown set')
 			} else {
 				throw new Error('Not supported by control')
 			}
 		} else {
-			if (control.supportsActions) {
-				if (!control.actionReplaceAll(stepId, setId, this.#currentSession.actions)) throw new Error('Unknown set')
+			if (control.supportsEntities) {
+				const listId: SomeSocketEntityLocation = { stepId, setId }
+				if (!control.entities.entityReplaceAll(listId, this.#currentSession.actions)) throw new Error('Unknown set')
 			} else {
 				throw new Error('Not supported by control')
 			}

companion/lib/Controls/ActionRunner.ts

@@ -1,8 +1,8 @@
 import { CoreBase } from '../Core/Base.js'
 import type { Registry } from '../Registry.js'
 import type { RunActionExtras } from '../Instance/Wrapper.js'
-import { ActionInstance } from '@companion-app/shared/Model/ActionModel.js'
 import { nanoid } from 'nanoid'
+import { ActionEntityModel, EntityModelType, SomeEntityModel } from '@companion-app/shared/Model/EntityModel.js'
 
 /**
  * Class to handle execution of actions.
@@ -32,13 +32,13 @@ export class ActionRunner extends CoreBase {
 	/**
 	 * Run a single action
 	 */
-	async #runAction(action: ActionInstance, extras: RunActionExtras): Promise<void> {
+	async #runAction(action: ActionEntityModel, extras: RunActionExtras): Promise<void> {
 		this.logger.silly('Running action', action)
 
-		if (action.instance === 'internal') {
+		if (action.connectionId === 'internal') {
 			await this.internalModule.executeAction(action, extras)
 		} else {
-			const instance = this.instance.moduleHost.getChild(action.instance)
+			const instance = this.instance.moduleHost.getChild(action.connectionId)
 			if (instance) {
 				await instance.actionRun(action, extras)
 			} else {
@@ -51,11 +51,13 @@ export class ActionRunner extends CoreBase {
 	 * Run multiple actions
 	 */
 	async runMultipleActions(
-		actions0: ActionInstance[],
+		actions0: SomeEntityModel[],
 		extras: RunActionExtras,
 		executeSequential = false
 	): Promise<void> {
-		const actions = actions0.filter((act) => !act.disabled)
+		const actions = actions0.filter(
+			(act): act is ActionEntityModel => act.type === EntityModelType.Action && !act.disabled
+		)
 		if (actions.length === 0) return
 
 		if (extras.abortDelayed.aborted) return
@@ -66,7 +68,7 @@ export class ActionRunner extends CoreBase {
 			for (const action of actions) {
 				if (extras.abortDelayed.aborted) break
 				await this.#runAction(action, extras).catch((e) => {
-					this.logger.silly(`Error executing action for ${action.instance}: ${e.message ?? e}`)
+					this.logger.silly(`Error executing action for ${action.connectionId}: ${e.message ?? e}`)
 				})
 			}
 		} else {
@@ -78,7 +80,7 @@ export class ActionRunner extends CoreBase {
 				if (waitAction) {
 					// Perform the wait action
 					await this.#runAction(waitAction, extras).catch((e) => {
-						this.logger.silly(`Error executing action for ${waitAction.instance}: ${e.message ?? e}`)
+						this.logger.silly(`Error executing action for ${waitAction.connectionId}: ${e.message ?? e}`)
 					})
 				}
 
@@ -87,7 +89,7 @@ export class ActionRunner extends CoreBase {
 					await Promise.all(
 						actions.map(async (action) =>
 							this.#runAction(action, extras).catch((e) => {
-								this.logger.silly(`Error executing action for ${action.instance}: ${e.message ?? e}`)
+								this.logger.silly(`Error executing action for ${action.connectionId}: ${e.message ?? e}`)
 							})
 						)
 					)
@@ -96,16 +98,16 @@ export class ActionRunner extends CoreBase {
 		}
 	}
 
-	#splitActionsAroundWaits(actions: ActionInstance[]): GroupedActionInstances[] {
-		const groupedActions: GroupedActionInstances[] = [
+	#splitActionsAroundWaits(actions: ActionEntityModel[]): GroupedActionEntityModels[] {
+		const groupedActions: GroupedActionEntityModels[] = [
 			{
 				waitAction: undefined,
 				actions: [],
 			},
 		]
 
 		for (const action of actions) {
-			if (action.action === 'wait') {
+			if (action.definitionId === 'wait') {
 				groupedActions.push({
 					waitAction: action,
 					actions: [],
@@ -119,9 +121,9 @@ export class ActionRunner extends CoreBase {
 	}
 }
 
-interface GroupedActionInstances {
-	waitAction: ActionInstance | undefined
-	actions: ActionInstance[]
+interface GroupedActionEntityModels {
+	waitAction: ActionEntityModel | undefined
+	actions: ActionEntityModel[]
 }
 
 export class ControlActionRunner {
@@ -142,7 +144,7 @@ export class ControlActionRunner {
 	}
 
 	async runActions(
-		actions: ActionInstance[],
+		actions: SomeEntityModel[],
 		extras: Omit<RunActionExtras, 'controlId' | 'abortDelayed' | 'executionMode'>
 	): Promise<void> {
 		const controller = new AbortController()

companion/lib/Controls/ControlBase.ts

@@ -196,11 +196,6 @@ export abstract class ControlBase<TJson> {
 	 */
 	abstract renameVariables(labelFrom: string, labelTo: string): void
 
-	/**
-	 * Prune any items on controls which belong to an unknown connectionId
-	 */
-	abstract verifyConnectionIds(knownConnectionIds: Set<string>): void
-
 	/**
 	 * Execute a press of a control
 	 * @param pressed Whether the control is pressed