feat: only include open surfaces in api

bitfocus · Feb 2, 2025 · 6e0a526 · 6e0a526
1 parent 8712618
commit 6e0a526
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 41 deletions.
diff --git a/openapi.yaml b/openapi.yaml
@@ -160,21 +160,21 @@ components:
         surfaceId:
           type: string
           description: ID of the surface
-        description:
+        productName:
           type: string
-          description: Description of the surface
+          description: Product Name of the surface
         pluginId:
           type: string
           description: Plugin ID of the surface
         pluginName:
           type: string
           description: Plugin name of the surface
-        isOpen:
-          type: boolean
-          description: Whether the surface is currently open
+        # isOpen:
+        #   type: boolean
+        #   description: Whether the surface is currently open
       required:
         - surfaceId
-        - description
+        - productName
         - pluginId
         - pluginName
-        - isOpen
+        # - isOpen
diff --git a/satellite/src/device-types/infinitton.ts b/satellite/src/device-types/infinitton.ts
@@ -71,7 +71,7 @@ export class InfinittonWrapper extends EventEmitter<WrappedSurfaceEvents> implem
 		return this.#deviceId
 	}
 	public get productName(): string {
-		return `Satellite Infinitton`
+		return `Infinitton`
 	}
 
 	public constructor(deviceId: string, panel: Infinitton, cardGenerator: CardGenerator) {

diff --git a/satellite/src/device-types/streamdeck.ts b/satellite/src/device-types/streamdeck.ts
@@ -63,7 +63,7 @@ const PLUGIN_ID = 'elgato-streamdeck'
 
 export class StreamDeckPlugin implements SurfacePlugin<StreamDeckDeviceInfo> {
 	readonly pluginId = PLUGIN_ID
-	readonly pluginName = 'Elgato StreamDeck'
+	readonly pluginName = 'Elgato Stream Deck'
 
 	async init(): Promise<void> {
 		// Nothing to do
@@ -115,7 +115,7 @@ export class StreamDeckWrapper extends EventEmitter<WrappedSurfaceEvents> implem
 		return this.#deviceId
 	}
 	public get productName(): string {
-		return `Satellite StreamDeck: ${this.#deck.MODEL}`
+		return this.#deck.PRODUCT_NAME
 	}
 
 	public constructor(deviceId: string, deck: StreamDeck, cardGenerator: CardGenerator) {

diff --git a/satellite/src/generated/openapi.ts b/satellite/src/generated/openapi.ts
@@ -98,14 +98,12 @@ export interface components {
         SurfaceInfo: {
             /** @description ID of the surface */
             surfaceId: string;
-            /** @description Description of the surface */
-            description: string;
+            /** @description Product Name of the surface */
+            productName: string;
             /** @description Plugin ID of the surface */
             pluginId: string;
             /** @description Plugin name of the surface */
             pluginName: string;
-            /** @description Whether the surface is currently open */
-            isOpen: boolean;
         };
     };
     responses: never;

diff --git a/satellite/src/surface-manager.ts b/satellite/src/surface-manager.ts
@@ -34,8 +34,6 @@ export class SurfaceManager {
 	#scanIsRunning = false
 	#scanPending = false
 
-	#lastScannedSurfaces: ApiSurfaceInfo[] = []
-
 	public static async create(client: CompanionSatelliteClient): Promise<SurfaceManager> {
 		const manager = new SurfaceManager(client)
 
@@ -266,8 +264,6 @@ export class SurfaceManager {
 		this.#scanIsRunning = true
 		this.#scanPending = false
 
-		const detectedSurfaces: ApiSurfaceInfo[] = []
-
 		void Promise.allSettled([
 			HID.devicesAsync()
 				.then(async (devices) => {
@@ -277,14 +273,6 @@ export class SurfaceManager {
 								const info = plugin.checkSupportsHidDevice?.(device)
 								if (!info) continue
 
-								detectedSurfaces.push({
-									pluginId: plugin.pluginId,
-									pluginName: plugin.pluginName,
-									surfaceId: info.surfaceId,
-									description: info.description,
-									isOpen: false,
-								})
-
 								this.#tryAddSurfaceFromPlugin(plugin, info)
 								return
 							}
@@ -300,14 +288,6 @@ export class SurfaceManager {
 					if (plugin.scanForSurfaces) {
 						const surfaceInfos = await plugin.scanForSurfaces()
 						for (const surfaceInfo of surfaceInfos) {
-							detectedSurfaces.push({
-								pluginId: plugin.pluginId,
-								pluginName: plugin.pluginName,
-								surfaceId: surfaceInfo.surfaceId,
-								description: surfaceInfo.description,
-								isOpen: false,
-							})
-
 							this.#tryAddSurfaceFromPlugin(plugin, surfaceInfo)
 						}
 					} else if (plugin.detection?.triggerScan) {
@@ -320,20 +300,18 @@ export class SurfaceManager {
 		]).finally(() => {
 			this.#scanIsRunning = false
 
-			this.#lastScannedSurfaces = detectedSurfaces
-
 			if (this.#scanPending) {
 				this.scanForSurfaces()
 			}
 		})
 	}
 
 	public getKnownSurfaces(): ApiSurfaceInfo[] {
-		// TODO - include auto-detected surfaces
-
-		return this.#lastScannedSurfaces.map((surface) => ({
-			...surface,
-			isOpen: this.#surfaces.has(surface.surfaceId),
+		return Array.from(this.#surfaces.values()).map((surface) => ({
+			pluginId: surface.pluginId,
+			pluginName: this.#plugins.get(surface.pluginId)?.pluginName ?? 'Unknown',
+			surfaceId: surface.surfaceId,
+			productName: surface.productName,
 		}))
 	}