feat: support ip streamdecks (#26)

Co-authored-by: Jan Starzak <[email protected]>

Author: Julusian

.node-version

@@ -1 +1 @@
-18.19
+22.15.1

.nvmrc

@@ -1 +1 @@
-18.19
+22.15.1

package.json

@@ -46,7 +46,7 @@
   "devDependencies": {
     "@sofie-automation/code-standard-preset": "~2.5.2",
     "@types/jest": "^29.5.12",
-    "@types/node": "^18.19.33",
+    "@types/node": "^22.15.21",
     "@types/sprintf-js": "^1.1.4",
     "@types/underscore": "^1.11.15",
     "concurrently": "^8.2.2",
@@ -64,11 +64,8 @@
     "zip-a-folder": "^3.1.6"
   },
   "prettier": "@sofie-automation/code-standard-preset/.prettierrc.json",
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.9.1",
   "dependencies": {
-    "@yao-pkg/pkg": "6.2.0"
-  },
-  "resolutions": {
-    "node-hid": "npm:@julusian/[email protected]"
+    "@yao-pkg/pkg": "^6.5.1"
   }
 }

packages/input-gateway/package.json

@@ -52,7 +52,7 @@
 		]
 	},
 	"engines": {
-		"node": "^18.19"
+		"node": "^22.15"
 	},
 	"files": [
 		"/dist",
@@ -74,8 +74,8 @@
 	"dependencies": {
 		"@esm2cjs/p-queue": "7.3.0",
 		"@sofie-automation/input-manager": "0.3.1-alpha.3",
-		"@sofie-automation/server-core-integration": "1.51.6",
-		"@sofie-automation/shared-lib": "1.51.6",
+		"@sofie-automation/server-core-integration": "1.52.0-nightly-release52-20250507-090800-3f13e1f.0",
+		"@sofie-automation/shared-lib": "1.52.0-nightly-release52-20250507-090800-3f13e1f.0",
 		"debug": "^4.3.4",
 		"eventemitter3": "5.0.1",
 		"p-all": "5.0.0",

packages/input-gateway/src/config.ts

@@ -1,4 +1,4 @@
-import { protectString } from '@sofie-automation/shared-lib/dist/lib/protectedString'
+import { protectString } from '@sofie-automation/server-core-integration'
 import { Config } from './connector'
 
 // CLI arguments / Environment variables --------------

packages/input-gateway/src/connector.ts

@@ -1,7 +1,7 @@
 import { CoreHandler, CoreConfig } from './coreHandler'
 import { Logger } from 'winston'
 import { Process } from './process'
-import { PeripheralDeviceId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
+import { PeripheralDeviceId } from '@sofie-automation/server-core-integration'
 
 export interface Config {
 	process: ProcessConfig

packages/input-gateway/src/coreHandler.ts

@@ -4,24 +4,21 @@ import {
 	DDPConnectorOptions,
 	PeripheralDevicePubSub,
 	PeripheralDevicePubSubCollectionsNames,
+	StatusCode,
+	PeripheralDeviceId,
+	PeripheralDeviceAPI,
+	protectString,
+	unprotectString,
+	stringifyError,
+	PeripheralDeviceCommand,
 } from '@sofie-automation/server-core-integration'
-import { StatusCode } from '@sofie-automation/shared-lib/dist/lib/status'
+import { PeripheralDeviceCommandId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
 import _ from 'underscore'
 import * as Winston from 'winston'
 import { DeviceConfig } from './inputManagerHandler'
 import fs from 'fs'
 import { INPUT_DEVICE_CONFIG } from './configManifest'
-import { PeripheralDeviceCommandId, PeripheralDeviceId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
-import {
-	PeripheralDeviceCategory,
-	PeripheralDeviceSubType,
-	PeripheralDeviceType,
-	PERIPHERAL_SUBTYPE_PROCESS,
-} from '@sofie-automation/shared-lib/dist/peripheralDevice/peripheralDeviceAPI'
-import { protectString, unprotectString } from '@sofie-automation/shared-lib/dist/lib/protectedString'
-import { PeripheralDeviceCommand } from '@sofie-automation/shared-lib/dist/core/model/PeripheralDeviceCommand'
 import { Process } from './process'
-import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyError'
 import path from 'path'
 
 export interface CoreConfig {
@@ -73,9 +70,7 @@ export class CoreHandler {
 		this._coreConfig = config
 		this._process = process
 
-		this.core = new CoreConnection(
-			this.getCoreConnectionOptions('Input Gateway', 'InputGateway', PERIPHERAL_SUBTYPE_PROCESS)
-		)
+		this.core = new CoreConnection(this.getCoreConnectionOptions())
 
 		this.core.onConnected(() => {
 			this.logger.info('Core Connected!')
@@ -104,10 +99,10 @@ export class CoreHandler {
 		}
 		await this.core.init(ddpConfig)
 		this.logger.info('Core id: ' + this.core.deviceId)
-		this._statusInitialized = true
-		await this.updateCoreStatus()
-
 		await this.setupObserversAndSubscriptions()
+		if (this._onConnected) this._onConnected()
+
+		this._statusInitialized = true
 
 		await this.updateCoreStatus()
 	}
@@ -140,20 +135,20 @@ export class CoreHandler {
 			await this.core.destroy()
 		}
 	}
-	getCoreConnectionOptions(name: string, subDeviceId: string, subDeviceType?: PeripheralDeviceSubType): CoreOptions {
+	private getCoreConnectionOptions(): CoreOptions {
 		if (!this._deviceOptions.deviceId) {
 			// this.logger.warn('DeviceId not set, using a temporary random id!')
 			throw new Error('DeviceId is not set!')
 		}
 
 		const options: CoreOptions = {
-			deviceId: protectString(this._deviceOptions.deviceId + subDeviceId),
+			deviceId: protectString(this._deviceOptions.deviceId + 'InputGateway'),
 			deviceToken: this._deviceOptions.deviceToken,
 
-			deviceCategory: PeripheralDeviceCategory.TRIGGER_INPUT,
-			deviceType: PeripheralDeviceType.INPUT,
+			deviceCategory: PeripheralDeviceAPI.PeripheralDeviceCategory.TRIGGER_INPUT,
+			deviceType: PeripheralDeviceAPI.PeripheralDeviceType.INPUT,
 
-			deviceName: name,
+			deviceName: 'Input Gateway',
 			watchDog: this._coreConfig ? this._coreConfig.watchdog : true,
 
 			configManifest: {
@@ -169,7 +164,6 @@ export class CoreHandler {
 			options.deviceToken = 'unsecureToken'
 		}
 
-		if (subDeviceType === PERIPHERAL_SUBTYPE_PROCESS) options.versions = this._getVersions()
 		return options
 	}
 	onConnected(fcn: () => any): void {

packages/input-manager/package.json

@@ -65,7 +65,7 @@
 		"generate-schema-types": "node ./scripts/schema-types.mjs"
 	},
 	"engines": {
-		"node": "^18.19"
+		"node": "^22.15"
 	},
 	"lint-staged": {
 		"*.{css,json,md,scss}": [
@@ -91,7 +91,8 @@
 		"production"
 	],
 	"dependencies": {
-		"@elgato-stream-deck/node": "7.1.2",
+		"@elgato-stream-deck/node": "7.3.0",
+		"@elgato-stream-deck/tcp": "7.3.0",
 		"@julusian/jpeg-turbo": "^2.1.0",
 		"easymidi": "^3.1.0",
 		"eventemitter3": "5.0.1",

packages/input-manager/src/devices/device.ts

@@ -34,7 +34,7 @@ export interface StatusChangeEventArgs {
 	status: StatusCode
 }
 
-type DeviceEvents = {
+export type DeviceEvents = {
 	/** A notification that a trigger was triggered, call this.getNextTrigger() to get it when it's time to send it to Core. */
 	trigger: []
 	statusChange: [e: StatusChangeEventArgs]
@@ -60,11 +60,11 @@ export abstract class Device extends EventEmitter<DeviceEvents> {
 		this.removeAllListeners()
 	}
 
-	protected addTriggerEvent(triggerEvent: TriggerEvent): void {
+	public addTriggerEvent(triggerEvent: TriggerEvent): void {
 		this.#triggerEvents.push(triggerEvent)
 		this.emit('trigger')
 	}
-	protected updateTriggerAnalog<T extends TriggerEventArguments>(
+	public updateTriggerAnalog<T extends TriggerEventArguments>(
 		triggerEvent: Omit<TriggerEvent, 'arguments'>,
 		updateArgumnets: (triggerAnalog: T | undefined) => T
 	): void {

packages/input-manager/src/generated/streamdeck.ts

@@ -9,6 +9,8 @@ export interface StreamDeckDeviceOptions {
 	path?: string
 	serialNumber?: string
 	index?: number
+	ip?: string
+	port?: number
 	brightness?: number
 	stylePresets?: {
 		[k: string]: StreamdeckStylePreset