feat: kairos connection SOFIE-4032

package.json

@@ -53,7 +53,7 @@
     "ts-jest": "^29.2.4",
     "ts-node": "^8.10.2",
     "typedoc": "^0.23.28",
-    "typescript": "~4.9.5"
+    "typescript": "~5.1"
   },
   "prettier": "@sofie-automation/code-standard-preset/.prettierrc.json",
   "packageManager": "[email protected]"

packages/timeline-state-resolver-api/src/device.ts

@@ -243,6 +243,14 @@ export interface DeviceContextAPI<DeviceState, AddressState = void> {
 	/** Reset the tracked device state to "state" and notify the conductor to reset the resolver */
 	resetToState: (state: DeviceState) => Promise<void>
 
+	/**
+	 * Reset the tracked device state to "state" and notify the conductor to reset the resolver
+	 * @param cb A callback that receives the current state, and should return the modified state.
+	 *           Note: The `currentState` argument is a clone, so it is safe to modify it directly.
+	 * 		     If no changes have been made, return false.
+	 */
+	setModifiedState: (cb: (currentState: DeviceState) => DeviceState | false) => Promise<void>
+
 	/** Calculate a new diff for the next state change */
 	recalcDiff: () => void
 

packages/timeline-state-resolver-api/tsconfig.build.json

@@ -9,6 +9,9 @@
 			"*": ["./node_modules/*"],
 			"{{PACKAGE-NAME}}": ["./src/index.ts"]
 		},
-		"types": ["node"]
+		"types": ["node"],
+
+		"moduleResolution": "node16",
+		"esModuleInterop": true
 	}
 }

packages/timeline-state-resolver-types/.eslintrc.json

@@ -1,3 +1,15 @@
 {
-	"extends": "../../node_modules/@sofie-automation/code-standard-preset/eslint/main"
+	"extends": "../../node_modules/@sofie-automation/code-standard-preset/eslint/main",
+	"overrides": [
+		{
+			"files": ["*.ts"],
+			"rules": {
+				"node/no-missing-import": ["error", { 
+					// Temporary issue, likely because the `node` plugin is rather outdated and doesnt correctly handle `exports` field in package.json
+					// This will go away once the code-standard-preset is updated to a newer version	
+					"allowModules": ["kairos-lib"] 
+				}]
+			}
+		}
+	]
 }

packages/timeline-state-resolver-types/package.json

@@ -83,6 +83,7 @@
 		"production"
 	],
 	"dependencies": {
+		"kairos-lib": "0.2.3",
 		"tslib": "^2.6.3"
 	},
 	"publishConfig": {

packages/timeline-state-resolver-types/src/__tests__/__snapshots__/index.spec.ts.snap

@@ -22,10 +22,13 @@ exports[`index imports 1`] = `
   "HttpMethod",
   "HttpSendActions",
   "HyperdeckActions",
+  "KairosActions",
+  "KairosMacroActiveState",
   "LawoDeviceMode",
   "MappingAtemType",
   "MappingCasparCGType",
   "MappingHyperdeckType",
+  "MappingKairosType",
   "MappingLawoType",
   "MappingMultiOscType",
   "MappingObsType",
@@ -57,6 +60,7 @@ exports[`index imports 1`] = `
   "TimelineContentTypeHTTP",
   "TimelineContentTypeHTTPParamType",
   "TimelineContentTypeHyperdeck",
+  "TimelineContentTypeKairos",
   "TimelineContentTypeLawo",
   "TimelineContentTypeMultiOSC",
   "TimelineContentTypeOBS",

packages/timeline-state-resolver-types/src/generated/device-options.ts

@@ -36,6 +36,11 @@ export interface DeviceOptionsHyperdeck extends DeviceOptionsBase<HyperdeckOptio
 	type: DeviceType.HYPERDECK
 }
 
+import type { KairosOptions } from './kairos'
+export interface DeviceOptionsKairos extends DeviceOptionsBase<KairosOptions> {
+	type: DeviceType.KAIROS
+}
+
 import type { LawoOptions } from './lawo'
 export interface DeviceOptionsLawo extends DeviceOptionsBase<LawoOptions> {
 	type: DeviceType.LAWO
@@ -133,6 +138,7 @@ export type DeviceOptionsAny =
 	| DeviceOptionsHttpSend
 	| DeviceOptionsHttpWatcher
 	| DeviceOptionsHyperdeck
+	| DeviceOptionsKairos
 	| DeviceOptionsLawo
 	| DeviceOptionsMultiOsc
 	| DeviceOptionsObs
@@ -165,6 +171,7 @@ export enum DeviceType {
 	HTTPSEND = 'HTTPSEND',
 	HTTPWATCHER = 'HTTPWATCHER',
 	HYPERDECK = 'HYPERDECK',
+	KAIROS = 'KAIROS',
 	LAWO = 'LAWO',
 	MULTI_OSC = 'MULTI_OSC',
 	OBS = 'OBS',

packages/timeline-state-resolver-types/src/generated/index.ts

@@ -27,6 +27,9 @@ import type { SomeMappingHttpWatcher } from './httpWatcher'
 export * from './hyperdeck'
 import type { SomeMappingHyperdeck } from './hyperdeck'
 
+export * from './kairos'
+import type { SomeMappingKairos } from './kairos'
+
 export * from './lawo'
 import type { SomeMappingLawo } from './lawo'
 
@@ -88,6 +91,7 @@ export type TSRMappingOptions =
 	| SomeMappingHttpSend
 	| SomeMappingHttpWatcher
 	| SomeMappingHyperdeck
+	| SomeMappingKairos
 	| SomeMappingLawo
 	| SomeMappingMultiOsc
 	| SomeMappingObs