chore: add common interfaces for Connector and CoreHandlers in server-core-integration

Author: nytamin

packages/mos-gateway/src/connector.ts

@@ -8,6 +8,7 @@ import {
 	stringifyError,
 	HealthConfig,
 	HealthEndpoints,
+	IConnector,
 } from '@sofie-automation/server-core-integration'
 
 export interface Config {
@@ -21,7 +22,7 @@ export interface DeviceConfig {
 	deviceId: PeripheralDeviceId
 	deviceToken: string
 }
-export class Connector {
+export class Connector implements IConnector {
 	public initialized = false
 	public initializedError: string | undefined = undefined
 

packages/mos-gateway/src/coreHandler.ts

@@ -10,6 +10,7 @@ import {
 	stringifyError,
 	PeripheralDevicePubSub,
 	PeripheralDevicePubSubCollectionsNames,
+	ICoreHandler,
 } from '@sofie-automation/server-core-integration'
 import * as Winston from 'winston'
 
@@ -29,7 +30,7 @@ export interface CoreConfig {
 /**
  * Represents a connection between mos-integration and Core
  */
-export class CoreHandler {
+export class CoreHandler implements ICoreHandler {
 	core: CoreConnection | undefined
 	logger: Winston.Logger
 	public _observers: Array<Observer<any>> = []

packages/playout-gateway/src/connector.ts

@@ -9,6 +9,7 @@ import {
 	stringifyError,
 	HealthConfig,
 	HealthEndpoints,
+	IConnector,
 } from '@sofie-automation/server-core-integration'
 
 export interface Config {
@@ -24,7 +25,7 @@ export interface DeviceConfig {
 	deviceId: PeripheralDeviceId
 	deviceToken: string
 }
-export class Connector {
+export class Connector implements IConnector {
 	public initialized = false
 	public initializedError: string | undefined = undefined
 

packages/playout-gateway/src/coreHandler.ts

@@ -11,6 +11,7 @@ import {
 	stringifyError,
 	PeripheralDevicePubSub,
 	PeripheralDevicePubSubCollectionsNames,
+	ICoreHandler,
 } from '@sofie-automation/server-core-integration'
 import { MediaObject, DeviceOptionsAny, ActionExecutionResult } from 'timeline-state-resolver'
 import _ from 'underscore'
@@ -40,7 +41,7 @@ export interface MemoryUsageReport {
 /**
  * Represents a connection between the Gateway and Core
  */
-export class CoreHandler {
+export class CoreHandler implements ICoreHandler {
 	core!: CoreConnection
 	logger: Logger
 	public _observers: Array<Observer<any>> = []

packages/server-core-integration/src/index.ts

@@ -1,6 +1,7 @@
 export * from './lib/coreConnection.js'
 export * from './lib/configManifest.js'
 export * from './lib/ddpClient.js'
+export * from './lib/gateway-types.js'
 export * from './lib/health.js'
 export * from './lib/methods.js'
 export * from './lib/process.js'

packages/server-core-integration/src/lib/gateway-types.ts

@@ -0,0 +1,11 @@
+import { StatusCode } from '@sofie-automation/shared-lib/dist/lib/status'
+
+export interface IConnector {
+	initialized: boolean
+	initializedError: string | undefined
+}
+
+export interface ICoreHandler {
+	getCoreStatus: () => { statusCode: StatusCode; messages: string[] }
+	connectedToCore: boolean
+}

packages/server-core-integration/src/lib/health.ts

@@ -2,6 +2,7 @@ import Koa from 'koa'
 import Router from '@koa/router'
 import { StatusCode } from '@sofie-automation/shared-lib/dist/lib/status'
 import { assertNever } from '@sofie-automation/shared-lib/dist/lib/lib'
+import { IConnector, ICoreHandler } from './gateway-types.js'
 
 export interface HealthConfig {
 	/** If set, exposes health HTTP endpoints on the given port */
@@ -15,16 +16,8 @@ export interface HealthConfig {
 export class HealthEndpoints {
 	private app = new Koa()
 	constructor(
-		private connector: {
-			// Connector analog
-			initialized: boolean
-			initializedError: string | undefined
-		},
-		private coreHandler: {
-			// CoreHandler analog
-			getCoreStatus: () => { statusCode: StatusCode; messages: string[] }
-			connectedToCore: boolean
-		},
+		private connector: IConnector,
+		private coreHandler: ICoreHandler,
 		private config: HealthConfig
 	) {
 		if (!config.port) return // disabled