feat: remove some deprecated fields

Companion now sets them to 'default' values, so they are no longer useful
bitfocus · Jan 6, 2024 · aabc536 · aabc536
1 parent 27ea96c
commit aabc536
Show file tree

Hide file tree

Showing 8 changed files with 3 additions and 64 deletions.
diff --git a/src/host-api/api.ts b/src/host-api/api.ts
@@ -152,9 +152,6 @@ export interface ExecuteActionMessage {
 
 	/** Identifier of the surface which triggered this action */
 	surfaceId: string | undefined
-
-	/** @deprecated will be removed in favor of `surfaceId` soon */
-	deviceId: string | undefined
 }
 
 export interface UpdateFeedbackValuesMessage {
@@ -186,14 +183,6 @@ export interface FeedbackInstance extends FeedbackInstanceBase {
 		width: number
 		height: number
 	}
-
-	/** @deprecated */
-	page: number
-	/** @deprecated */
-	bank: number
-
-	/** @deprecated */
-	rawBank: any
 }
 
 export interface UpdateConfigAndLabelMessage {
@@ -217,11 +206,6 @@ export interface ActionInstanceBase {
 }
 export interface ActionInstance extends ActionInstanceBase {
 	controlId: string
-
-	/** @deprecated */
-	page: number | null
-	/** @deprecated */
-	bank: number | null
 }
 
 export interface UpdateActionInstancesMessage {

diff --git a/src/internal/__tests__/feedback.spec.ts b/src/internal/__tests__/feedback.spec.ts
@@ -26,9 +26,6 @@ const feedback: FeedbackInstance = {
 
 	controlId: 'control0',
 	image: undefined,
-	page: 0,
-	bank: 0,
-	rawBank: 'test' as any,
 }
 
 const feedbackId2 = 'abc123'
@@ -43,9 +40,6 @@ const feedback2: FeedbackInstance = {
 
 	controlId: 'control1',
 	image: undefined,
-	page: 0,
-	bank: 0,
-	rawBank: 'test' as any,
 }
 
 const unimplementedAsyncFunction = async () => {
@@ -160,7 +154,6 @@ describe('FeedbackManager', () => {
 				feedbackId: feedback.feedbackId,
 				controlId: feedback.controlId,
 				options: feedback.options,
-				_rawBank: feedback.rawBank,
 			},
 			expect.anything()
 		)

diff --git a/src/internal/__tests__/upgrade.spec.ts b/src/internal/__tests__/upgrade.spec.ts
@@ -149,8 +149,6 @@ describe('runThroughUpgradeScripts', () => {
 			actionId: 'my-action',
 			options: { a: 1, b: 2 },
 			controlId: 'control0',
-			page: null,
-			bank: null,
 		}
 		const action1Before: ActionInstance = {
 			id: 'act1',
@@ -159,8 +157,6 @@ describe('runThroughUpgradeScripts', () => {
 			actionId: 'my-action',
 			options: { c: 1, d: 2 },
 			controlId: 'control1',
-			page: null,
-			bank: null,
 		}
 
 		const scripts = createMockScripts(2)
@@ -215,8 +211,6 @@ describe('runThroughUpgradeScripts', () => {
 			actionId: 'my-action',
 			options: { a: 1, b: 2 },
 			controlId: 'control0',
-			page: null,
-			bank: null,
 		}
 		const action1Before: ActionInstance = {
 			id: 'act1',
@@ -225,8 +219,6 @@ describe('runThroughUpgradeScripts', () => {
 			actionId: 'my-action',
 			options: { c: 1, d: 2 },
 			controlId: 'control1',
-			page: null,
-			bank: null,
 		}
 
 		const scripts = createMockScripts(2)

diff --git a/src/internal/actions.ts b/src/internal/actions.ts
@@ -70,11 +70,7 @@ export class ActionManager {
 				controlId: msg.action.controlId,
 				options: msg.action.options,
 
-				surfaceId: msg.surfaceId ?? msg.deviceId,
-
-				_deviceId: msg.surfaceId ?? msg.deviceId,
-				_page: msg.action.page,
-				_bank: msg.action.bank,
+				surfaceId: msg.surfaceId,
 			},
 			context
 		)
@@ -164,10 +160,6 @@ export class ActionManager {
 					options: msg.action.options,
 
 					surfaceId: undefined,
-
-					_deviceId: undefined,
-					_page: msg.action.page,
-					_bank: msg.action.bank,
 				},
 				context
 			)

diff --git a/src/internal/feedback.ts b/src/internal/feedback.ts
@@ -294,7 +294,6 @@ export class FeedbackManager {
 							{
 								...convertFeedbackInstanceToEvent('boolean', feedback),
 								type: 'boolean',
-								_rawBank: feedback.rawBank,
 							},
 							context
 						)
@@ -304,9 +303,6 @@ export class FeedbackManager {
 								...convertFeedbackInstanceToEvent('advanced', feedback),
 								type: 'advanced',
 								image: feedback.image,
-								_page: feedback.page,
-								_bank: feedback.bank,
-								_rawBank: feedback.rawBank,
 							},
 							context
 						)

diff --git a/src/manifest.ts b/src/manifest.ts
@@ -16,8 +16,7 @@ export function validateManifest(manifest: ModuleManifest): void {
 	if (manifestStr.includes('A short one line description of your module'))
 		throw new Error(`Manifest incorrectly references template module 'A short one line description of your module'`)
 
-	if (manifestStr.includes('Your name'))
-		throw new Error(`Manifest incorrectly references template module 'Your name'`)
+	if (manifestStr.includes('Your name')) throw new Error(`Manifest incorrectly references template module 'Your name'`)
 
 	if (manifestStr.includes('Your email'))
 		throw new Error(`Manifest incorrectly references template module 'Your email'`)

diff --git a/src/module-api/action.ts b/src/module-api/action.ts
@@ -92,11 +92,4 @@ export interface CompanionActionInfo {
 export interface CompanionActionEvent extends CompanionActionInfo {
 	/** Identifier of the surface which triggered this action */
 	readonly surfaceId: string | undefined
-
-	/** @deprecated use `surfaceId` instead */
-	readonly _deviceId: string | undefined
-	/** @deprecated */
-	readonly _page: number | null
-	/** @deprecated */
-	readonly _bank: number | null
 }
diff --git a/src/module-api/feedback.ts b/src/module-api/feedback.ts
@@ -39,11 +39,9 @@ export interface CompanionFeedbackInfo {
 /**
  * Extended information for execution of a boolean feedback
  */
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface CompanionFeedbackBooleanEvent extends CompanionFeedbackInfo {
 	// readonly type: 'boolean'
-
-	/** @deprecated */
-	readonly _rawBank: any
 }
 
 /**
@@ -57,14 +55,6 @@ export interface CompanionFeedbackAdvancedEvent extends CompanionFeedbackInfo {
 		readonly width: number
 		readonly height: number
 	}
-
-	/** @deprecated */
-	readonly _page: number
-	/** @deprecated */
-	readonly _bank: number
-
-	/** @deprecated */
-	readonly _rawBank: any
 }
 
 /**