refactor(LSG): remove redundant type

ianshade · ianshade · commit 17046571ec2a · 2025-02-17T20:17:08.000+01:00
diff --git a/packages/live-status-gateway/src/collectionBase.ts b/packages/live-status-gateway/src/collectionBase.ts
@@ -12,7 +12,8 @@ import { Logger } from 'winston'
 import { CoreHandler } from './coreHandler'
 import { arePropertiesShallowEqual } from './helpers/equality'
 import { CollectionHandlers } from './liveStatusServer'
-import { ObserverCallback } from './wsHandler'
+
+export type ObserverCallback<T, K extends keyof T> = (data: Pick<T, K> | undefined) => void
 
 export const DEFAULT_THROTTLE_PERIOD_MS = 20
 
diff --git a/packages/live-status-gateway/src/collections/globalAdLibsHandler.ts b/packages/live-status-gateway/src/collections/globalAdLibsHandler.ts
@@ -3,6 +3,7 @@ import { CoreHandler } from '../coreHandler'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
 import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 import { RundownContentHandlerBase } from './rundownContentHandlerBase'
+
 export class GlobalAdLibsHandler extends RundownContentHandlerBase<CorelibPubSub.rundownBaselineAdLibPieces> {
 	constructor(logger: Logger, coreHandler: CoreHandler) {
 		super(CollectionName.RundownBaselineAdLibPieces, CorelibPubSub.rundownBaselineAdLibPieces, logger, coreHandler)
diff --git a/packages/live-status-gateway/src/collections/partHandler.ts b/packages/live-status-gateway/src/collections/partHandler.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
@@ -18,10 +17,7 @@ type Playlist = PickKeys<DBRundownPlaylist, typeof PLAYLIST_KEYS>
 const PART_INSTANCES_KEYS = ['current'] as const
 type PartInstances = PickKeys<SelectedPartInstances, typeof PART_INSTANCES_KEYS>
 
-export class PartHandler
-	extends PublicationCollection<DBPart, CorelibPubSub.parts, CollectionName.Parts>
-	implements Collection<DBPart>
-{
+export class PartHandler extends PublicationCollection<DBPart, CorelibPubSub.parts, CollectionName.Parts> {
 	private _activePlaylist: Playlist | undefined
 	private _currentPartInstance: DBPartInstance | undefined
 
diff --git a/packages/live-status-gateway/src/collections/partInstancesHandler.ts b/packages/live-status-gateway/src/collections/partInstancesHandler.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
@@ -31,10 +30,11 @@ const PLAYLIST_KEYS = [
 ] as const
 type Playlist = PickKeys<DBRundownPlaylist, typeof PLAYLIST_KEYS>
 
-export class PartInstancesHandler
-	extends PublicationCollection<SelectedPartInstances, CorelibPubSub.partInstances, CollectionName.PartInstances>
-	implements Collection<SelectedPartInstances>
-{
+export class PartInstancesHandler extends PublicationCollection<
+	SelectedPartInstances,
+	CorelibPubSub.partInstances,
+	CollectionName.PartInstances
+> {
 	private _currentPlaylist: Playlist | undefined
 	private _rundownIds: RundownId[] = []
 	private _activationId: RundownPlaylistActivationId | undefined
diff --git a/packages/live-status-gateway/src/collections/partsHandler.ts b/packages/live-status-gateway/src/collections/partsHandler.ts
@@ -1,14 +1,13 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { CollectionBase } from '../collectionBase'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 import _ = require('underscore')
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
 
 const THROTTLE_PERIOD_MS = 200
 
-export class PartsHandler extends CollectionBase<DBPart[], CollectionName.Parts> implements Collection<DBPart[]> {
+export class PartsHandler extends CollectionBase<DBPart[], CollectionName.Parts> {
 	private throttledNotify: (data: DBPart[]) => void
 
 	constructor(logger: Logger, coreHandler: CoreHandler) {
diff --git a/packages/live-status-gateway/src/collections/pieceInstancesHandler.ts b/packages/live-status-gateway/src/collections/pieceInstancesHandler.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { PieceInstance } from '@sofie-automation/corelib/dist/dataModel/PieceInstance'
@@ -52,10 +51,11 @@ export interface SelectedPieceInstances {
 	nextPartInstance: PieceInstanceMin[]
 }
 
-export class PieceInstancesHandler
-	extends PublicationCollection<SelectedPieceInstances, CorelibPubSub.pieceInstances, CollectionName.PieceInstances>
-	implements Collection<SelectedPieceInstances>
-{
+export class PieceInstancesHandler extends PublicationCollection<
+	SelectedPieceInstances,
+	CorelibPubSub.pieceInstances,
+	CollectionName.PieceInstances
+> {
 	private _currentPlaylist: Playlist | undefined
 	private _partInstanceIds: PartInstanceId[] = []
 	private _sourceLayers: SourceLayers = {}
diff --git a/packages/live-status-gateway/src/collections/playlistHandler.ts b/packages/live-status-gateway/src/collections/playlistHandler.ts
@@ -1,17 +1,13 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { CollectionBase } from '../collectionBase'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
 import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 import { CollectionHandlers } from '../liveStatusServer'
 
-export class PlaylistsHandler
-	extends CollectionBase<DBRundownPlaylist[], CollectionName.RundownPlaylists>
-	implements Collection<DBRundownPlaylist[]>
-{
+export class PlaylistsHandler extends CollectionBase<DBRundownPlaylist[], CollectionName.RundownPlaylists> {
 	constructor(logger: Logger, coreHandler: CoreHandler) {
 		super(CollectionName.RundownPlaylists, logger, coreHandler)
 	}
@@ -23,10 +19,11 @@ export class PlaylistsHandler
 	}
 }
 
-export class PlaylistHandler
-	extends PublicationCollection<DBRundownPlaylist, CorelibPubSub.rundownPlaylists, CollectionName.RundownPlaylists>
-	implements Collection<DBRundownPlaylist>
-{
+export class PlaylistHandler extends PublicationCollection<
+	DBRundownPlaylist,
+	CorelibPubSub.rundownPlaylists,
+	CollectionName.RundownPlaylists
+> {
 	private _playlistsHandler: PlaylistsHandler
 
 	constructor(logger: Logger, coreHandler: CoreHandler) {
diff --git a/packages/live-status-gateway/src/collections/rundownContentHandlerBase.ts b/packages/live-status-gateway/src/collections/rundownContentHandlerBase.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { CorelibPubSubCollections, CorelibPubSubTypes } from '@sofie-automation/corelib/dist/pubsub'
 import { RundownId } from '@sofie-automation/corelib/dist/dataModel/Ids'
@@ -22,14 +21,11 @@ type RundownMatchingKeys = MatchingKeys<CorelibPubSubTypes, [RundownId[], (strin
 /**
  * For items whose `rundownId` should equal `rundownId` of the current Part (or next Part, if the firts Take was not performed)
  */
-export abstract class RundownContentHandlerBase<TPubSub extends RundownMatchingKeys>
-	extends PublicationCollection<
-		CollectionDocCheck<CorelibPubSubCollections[ReturnType<CorelibPubSubTypes[TPubSub]>]>[],
-		TPubSub,
-		ReturnType<CorelibPubSubTypes[TPubSub]>
-	>
-	implements Collection<CollectionDocCheck<CorelibPubSubCollections[ReturnType<CorelibPubSubTypes[TPubSub]>]>[]>
-{
+export abstract class RundownContentHandlerBase<TPubSub extends RundownMatchingKeys> extends PublicationCollection<
+	CollectionDocCheck<CorelibPubSubCollections[ReturnType<CorelibPubSubTypes[TPubSub]>]>[],
+	TPubSub,
+	ReturnType<CorelibPubSubTypes[TPubSub]>
+> {
 	private _currentRundownId: RundownId | undefined
 
 	constructor(
diff --git a/packages/live-status-gateway/src/collections/rundownHandler.ts b/packages/live-status-gateway/src/collections/rundownHandler.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { DBRundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
@@ -15,10 +14,11 @@ import { PickKeys } from '@sofie-automation/shared-lib/dist/lib/types'
 const PLAYLIST_KEYS = ['_id', 'currentPartInfo', 'nextPartInfo'] as const
 type Playlist = PickKeys<DBRundownPlaylist, typeof PLAYLIST_KEYS>
 
-export class RundownHandler
-	extends PublicationCollection<DBRundown, CorelibPubSub.rundownsInPlaylists, CollectionName.Rundowns>
-	implements Collection<DBRundown>
-{
+export class RundownHandler extends PublicationCollection<
+	DBRundown,
+	CorelibPubSub.rundownsInPlaylists,
+	CollectionName.Rundowns
+> {
 	private _currentPlaylistId: RundownPlaylistId | undefined
 	private _currentRundownId: RundownId | undefined
 
diff --git a/packages/live-status-gateway/src/collections/rundownsHandler.ts b/packages/live-status-gateway/src/collections/rundownsHandler.ts
@@ -1,14 +1,10 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { CollectionBase } from '../collectionBase'
 import { DBRundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
 
-export class RundownsHandler
-	extends CollectionBase<DBRundown[], CollectionName.Rundowns>
-	implements Collection<DBRundown[]>
-{
+export class RundownsHandler extends CollectionBase<DBRundown[], CollectionName.Rundowns> {
 	constructor(logger: Logger, coreHandler: CoreHandler) {
 		super(CollectionName.Rundowns, logger, coreHandler)
 	}
diff --git a/packages/live-status-gateway/src/collections/segmentHandler.ts b/packages/live-status-gateway/src/collections/segmentHandler.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import { SelectedPartInstances } from './partInstancesHandler'
@@ -19,10 +18,7 @@ type Playlist = PickKeys<DBRundownPlaylist, typeof PLAYLIST_KEYS>
 const PART_INSTANCES_KEYS = ['current'] as const
 type PartInstances = PickKeys<SelectedPartInstances, typeof PART_INSTANCES_KEYS>
 
-export class SegmentHandler
-	extends PublicationCollection<DBSegment, CorelibPubSub.segments, CollectionName.Segments>
-	implements Collection<DBSegment>
-{
+export class SegmentHandler extends PublicationCollection<DBSegment, CorelibPubSub.segments, CollectionName.Segments> {
 	private _currentSegmentId: SegmentId | undefined
 	private _rundownIds: RundownId[] = []
 
diff --git a/packages/live-status-gateway/src/collections/segmentsHandler.ts b/packages/live-status-gateway/src/collections/segmentsHandler.ts
@@ -1,17 +1,13 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { CollectionBase } from '../collectionBase'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import * as _ from 'underscore'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
 
 const THROTTLE_PERIOD_MS = 200
 
-export class SegmentsHandler
-	extends CollectionBase<DBSegment[], CollectionName.Segments>
-	implements Collection<DBSegment[]>
-{
+export class SegmentsHandler extends CollectionBase<DBSegment[], CollectionName.Segments> {
 	private throttledNotify: (data: DBSegment[]) => void
 
 	constructor(logger: Logger, coreHandler: CoreHandler) {
diff --git a/packages/live-status-gateway/src/collections/showStyleBaseHandler.ts b/packages/live-status-gateway/src/collections/showStyleBaseHandler.ts
@@ -1,6 +1,5 @@
 import { Logger } from 'winston'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { DBRundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
 import { DBShowStyleBase, OutputLayers, SourceLayers } from '@sofie-automation/corelib/dist/dataModel/ShowStyleBase'
@@ -17,10 +16,11 @@ export interface ShowStyleBaseExt extends DBShowStyleBase {
 	sourceLayers: SourceLayers
 }
 
-export class ShowStyleBaseHandler
-	extends PublicationCollection<ShowStyleBaseExt, CorelibPubSub.showStyleBases, CollectionName.ShowStyleBases>
-	implements Collection<ShowStyleBaseExt>
-{
+export class ShowStyleBaseHandler extends PublicationCollection<
+	ShowStyleBaseExt,
+	CorelibPubSub.showStyleBases,
+	CollectionName.ShowStyleBases
+> {
 	private _showStyleBaseId: ShowStyleBaseId | undefined
 	private _sourceLayersMap: Map<string, string> = new Map()
 	private _outputLayersMap: Map<string, string> = new Map()
diff --git a/packages/live-status-gateway/src/collections/studioHandler.ts b/packages/live-status-gateway/src/collections/studioHandler.ts
@@ -1,16 +1,12 @@
 import { Logger } from 'winston'
 import { DBStudio } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { CoreHandler } from '../coreHandler'
-import { Collection } from '../wsHandler'
 import { PublicationCollection } from '../publicationCollection'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
 import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 import { CollectionHandlers } from '../liveStatusServer'
 
-export class StudioHandler
-	extends PublicationCollection<DBStudio, CorelibPubSub.studios, CollectionName.Studios>
-	implements Collection<DBStudio>
-{
+export class StudioHandler extends PublicationCollection<DBStudio, CorelibPubSub.studios, CollectionName.Studios> {
 	constructor(logger: Logger, coreHandler: CoreHandler) {
 		super(CollectionName.Studios, CorelibPubSub.studios, logger, coreHandler)
 	}
diff --git a/packages/live-status-gateway/src/publicationCollection.ts b/packages/live-status-gateway/src/publicationCollection.ts
@@ -10,7 +10,7 @@ import { ParametersOfFunctionOrNever } from '@sofie-automation/server-core-integ
 import { Logger } from 'winston'
 import { CollectionBase, DEFAULT_THROTTLE_PERIOD_MS } from './collectionBase'
 import { CoreHandler } from './coreHandler'
-import { ObserverCallback } from './wsHandler'
+import { ObserverCallback } from './collectionBase'
 
 export abstract class PublicationCollection<
 	T,
diff --git a/packages/live-status-gateway/src/wsHandler.ts b/packages/live-status-gateway/src/wsHandler.ts
@@ -1,7 +1,6 @@
 import { Logger } from 'winston'
 import { WebSocket } from 'ws'
 import _ = require('underscore')
-import { CollectionHandlers } from './liveStatusServer'
 
 export abstract class WebSocketTopicBase {
 	protected _name: string
@@ -84,19 +83,6 @@ export interface WebSocketTopic {
 	sendMessage(ws: WebSocket, msg: object): void
 }
 
-export interface Collection<T> {
-	init(handlers: CollectionHandlers): void
-	close(): void
-	subscribe<K extends keyof T>(callback: ObserverCallback<T, K>, keys?: K[]): void
-	notify(data: T | undefined): void
-}
-
-export type ObserverCallback<T, K extends keyof T> = (data: Pick<T, K> | undefined) => void
-
-// export interface CollectionObserver<T, K extends keyof T> {
-// 	observerName: string
-// 	update(source: string, data: Pick<T, K> | undefined): void
-// }
 function isIterable<T>(obj: T | Iterable<T>): obj is Iterable<T> {
 	// checks for null and undefined
 	if (obj == null) {
