V2 fix socket (#296)

* refactor: rename timer endpoint

* refactor: typescript

* refactor: rename eventData and viewSettings

* refactor: message manager uses event store

apps/server/src/app.ts

@@ -14,7 +14,7 @@ import { OSCSettings } from 'ontime-types';
 
 // Import Routes
 import { router as rundownRouter } from './routes/rundownRouter.js';
-import { router as eventRouter } from './routes/eventRouter.js';
+import { router as eventDataRouter } from './routes/eventDataRouter.js';
 import { router as ontimeRouter } from './routes/ontimeRouter.js';
 import { router as playbackRouter } from './routes/playbackRouter.js';
 
@@ -54,7 +54,7 @@ app.use(express.json({ limit: '1mb' }));
 
 // Implement route endpoints
 app.use('/eventlist', rundownRouter);
-app.use('/event', eventRouter);
+app.use('/eventdata', eventDataRouter);
 app.use('/ontime', ontimeRouter);
 app.use('/playback', playbackRouter);
 
@@ -100,7 +100,7 @@ enum OntimeStartOrder {
 }
 
 let step = OntimeStartOrder.InitDB;
-const checkStart = (currentState) => {
+const checkStart = (currentState: OntimeStartOrder) => {
   if (step !== currentState) {
     step = OntimeStartOrder.Error;
     throw new Error('Init order error: startDb > startServer > startOsc > startIntegrations');
@@ -131,8 +131,6 @@ export const startServer = async () => {
   expressServer.listen(serverPort, '0.0.0.0');
 
   socketServer.initServer(expressServer);
-  socketServer.info('SERVER', 'Socket initialised');
-
   socketServer.info('SERVER', returnMessage);
   socketServer.startListener();
 

apps/server/src/classes/data-provider/DataProvider.ts

@@ -2,6 +2,8 @@
  * Class Event Provider is a mediator for handling the local db
  * and adds logic specific to ontime data
  */
+import { EventData, ViewSettings } from 'ontime-types';
+
 import { data, db } from '../../modules/loadDb.js';
 import { safeMerge } from './DataProvider.utils.js';
 
@@ -10,14 +12,14 @@ export class DataProvider {
     return data;
   }
 
-  static async setEventData(newData) {
-    data.event = { ...data.event, ...newData };
+  static async setEventData(newData: EventData) {
+    data.eventData = { ...data.eventData, ...newData };
     await this.persist();
-    return data.event;
+    return data.eventData;
   }
 
   static getEventData() {
-    return data.event;
+    return data.eventData;
   }
 
   static async setRundown(newData) {
@@ -40,7 +42,6 @@ export class DataProvider {
   }
 
   static async deleteEvent(eventId) {
-    // @ts-expect-error -- this will go away once we type db
     data.rundown = Array.from(data.rundown).filter((e) => e.id !== eventId);
     await this.persist();
   }
@@ -128,12 +129,12 @@ export class DataProvider {
     return { ...data.userFields };
   }
 
-  static getViews() {
-    return { ...data.views };
+  static getViewSettings() {
+    return { ...data.viewSettings };
   }
 
-  static async setViews(newData) {
-    data.views = { ...newData };
+  static async setViewSettings(newData: ViewSettings) {
+    data.viewSettings = { ...newData };
     await this.persist();
   }
 
@@ -158,8 +159,9 @@ export class DataProvider {
 
   static async mergeIntoData(newData) {
     const mergedData = safeMerge(data, newData);
-    data.event = mergedData.event;
+    data.eventData = mergedData.event;
     data.settings = mergedData.settings;
+    data.viewSettings = mergedData.viewSettings;
     data.osc = mergedData.osc;
     data.http = mergedData.http;
     data.aliases = mergedData.aliases;

apps/server/src/classes/data-provider/DataProvider.utils.ts

@@ -4,15 +4,13 @@
  * @param {object} newData
  */
 export function safeMerge(existing, newData) {
-  const { rundown, event, settings, osc, http, aliases, userFields } = newData || {};
+  const { rundown, event, settings, viewSettings, osc, http, aliases, userFields } = newData || {};
   return {
     ...existing,
     rundown: rundown ?? existing.rundown,
     event: { ...existing.event, ...event },
     settings: { ...existing.settings, ...settings },
-    views: {
-      overrideStyles: false,
-    },
+    viewSettings: { ...existing.viewSettings, ...viewSettings },
     aliases: aliases ?? existing.aliases,
     userFields: {
       ...existing.userFields,

apps/server/src/classes/event-loader/EventLoader.ts

@@ -1,12 +1,34 @@
-import { DataProvider } from '../data-provider/DataProvider.ts';
+import { DataProvider } from '../data-provider/DataProvider.js';
 import { getRollTimers } from '../../services/rollUtils.js';
+import { eventStore } from '../../stores/EventStore.js';
 
 let instance;
 
+type TitleBlock = {
+  titleNow: string | null;
+  subtitleNow: string | null;
+  presenterNow: string | null;
+  noteNow: string | null;
+  titleNext: string | null;
+  subtitleNext: string | null;
+  presenterNext: string | null;
+  noteNext: string | null;
+};
+
 /**
  * Manages business logic around loading events
  */
 export class EventLoader {
+  loadedEvent: object | null;
+  numEvents: number | null;
+  selectedEventIndex: number | null;
+  selectedEventId: string | null;
+  selectedPublicEventId: string | null;
+  nextEventId: string | null;
+  nextPublicEventId: string | null;
+  titles: TitleBlock;
+  titlesPublic: TitleBlock;
+
   constructor() {
     if (instance) {
       throw new Error('There can be only one');
@@ -14,7 +36,7 @@ export class EventLoader {
 
     // eslint-disable-next-line @typescript-eslint/no-this-alias -- this logic is used to ensure singleton
     instance = this;
-    this.reset();
+    this.reset(false);
     this.loadedEvent = null;
   }
 
@@ -119,11 +141,7 @@ export class EventLoader {
    */
   findNext() {
     const timedEvents = EventLoader.getPlayableEvents();
-    if (
-      timedEvents === null ||
-      !timedEvents.length ||
-      this.selectedEventIndex === this.numEvents - 1
-    ) {
+    if (timedEvents === null || !timedEvents.length || this.selectedEventIndex === this.numEvents - 1) {
       return null;
     }
 
@@ -145,15 +163,8 @@ export class EventLoader {
       return null;
     }
 
-    const {
-      nowIndex,
-      timers,
-      timeToNext,
-      nextEvent,
-      nextPublicEvent,
-      currentEvent,
-      currentPublicEvent,
-    } = getRollTimers(timedEvents, timeNow);
+    const { nowIndex, timers, timeToNext, nextEvent, nextPublicEvent, currentEvent, currentPublicEvent } =
+      getRollTimers(timedEvents, timeNow);
 
     this.loadedEvent = currentEvent;
     this.selectedEventIndex = nowIndex;
@@ -187,7 +198,10 @@ export class EventLoader {
     };
   }
 
-  reset() {
+  /**
+   * Resets instance state
+   */
+  reset(emit?: boolean) {
     this.loadedEvent = null;
     this.selectedEventIndex = null;
     this.selectedEventId = null;
@@ -209,10 +223,17 @@ export class EventLoader {
       titleNow: null,
       subtitleNow: null,
       presenterNow: null,
+      noteNow: null,
       titleNext: null,
       subtitleNext: null,
       presenterNext: null,
+      noteNext: null,
     };
+
+    // workaround for socket not being ready in constructor
+    if (emit) {
+      this._loadEvent();
+    }
   }
 
   /**
@@ -236,16 +257,26 @@ export class EventLoader {
     this._loadTitlesNow(event, playableEvents);
     this._loadTitlesNext(playableEvents);
 
+    this._loadEvent();
+
     return this.getLoaded();
   }
 
+  /**
+   * Handle side effects from event loading
+   */
+  private _loadEvent() {
+    eventStore.set('titles', this.titles);
+    eventStore.set('titlesPublic', this.titlesPublic);
+  }
+
   /**
    * @description loads given title (now)
    * @private
    * @param {object} event
    * @param {array} rundown
    */
-  _loadTitlesNow(event, rundown) {
+  private _loadTitlesNow(event, rundown) {
     // private title is always current
     // check if current is also public
     if (event.isPublic) {
@@ -276,8 +307,7 @@ export class EventLoader {
    * @description look for next titles to load
    * @private
    */
-  _loadTitlesNext(rundown) {
-    // Todo: is there a scenario where this gets called without an event?
+  private _loadTitlesNext(rundown) {
     // maybe there is nothing to load
     if (this.selectedEventIndex === null) return;
 
@@ -324,7 +354,7 @@ export class EventLoader {
    * @param type
    * @private
    */
-  _loadThisTitles(event, type) {
+  private _loadThisTitles(event, type) {
     if (!event) {
       return;
     }
@@ -336,6 +366,7 @@ export class EventLoader {
         this.titlesPublic.titleNow = event.title;
         this.titlesPublic.subtitleNow = event.subtitle;
         this.titlesPublic.presenterNow = event.presenter;
+        this.titlesPublic.noteNow = event.note;
         this.selectedPublicEventId = event.id;
 
         // private
@@ -350,6 +381,7 @@ export class EventLoader {
         this.titlesPublic.titleNow = event.title;
         this.titlesPublic.subtitleNow = event.subtitle;
         this.titlesPublic.presenterNow = event.presenter;
+        this.titlesPublic.noteNow = event.note;
         this.selectedPublicEventId = event.id;
         break;
 
@@ -367,6 +399,7 @@ export class EventLoader {
         this.titlesPublic.titleNext = event.title;
         this.titlesPublic.subtitleNext = event.subtitle;
         this.titlesPublic.presenterNext = event.presenter;
+        this.titlesPublic.noteNext = event.note;
         this.nextPublicEventId = event.id;
 
         // private
@@ -381,6 +414,7 @@ export class EventLoader {
         this.titlesPublic.titleNext = event.title;
         this.titlesPublic.subtitleNext = event.subtitle;
         this.titlesPublic.presenterNext = event.presenter;
+        this.titlesPublic.noteNext = event.note;
         this.nextPublicEventId = event.id;
         break;
 

apps/server/src/classes/message-manager/MessageManager.js

@@ -1,104 +0,0 @@
-let instance;
-
-class MessageService {
-  constructor() {
-    if (instance) {
-      throw new Error('There can be only one');
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-this-alias -- this logic is used to ensure singleton
-    instance = this;
-    this.socket = null;
-
-    this.presenter = {
-      text: '',
-      visible: false,
-    };
-    this.public = {
-      text: '',
-      visible: false,
-    };
-    this.lower = {
-      text: '',
-      visible: false,
-    };
-    this.onAir = false;
-  }
-
-  /**
-   * @description sets message on stage timer screen
-   * @param payload {string}
-   */
-  setTimerText(payload) {
-    this.presenter.text = payload;
-    return this.getAll();
-  }
-
-  /**
-   * @description sets message visibility on stage timer screen
-   * @param status {boolean}
-   */
-  setTimerVisibility(status) {
-    this.presenter.visible = status;
-    return this.getAll();
-  }
-
-  /**
-   * @description sets message on public screen
-   * @param payload {string}
-   */
-  setPublicText(payload) {
-    this.public.text = payload;
-    return this.getAll();
-  }
-
-  /**
-   * @description sets message visibility on public screen
-   * @param status {boolean}
-   */
-  setPublicVisibility(status) {
-    this.public.visible = status;
-    return this.getAll();
-  }
-
-  /**
-   * @description sets message on lower third screen
-   * @param payload {string}
-   */
-  setLowerText(payload) {
-    this.lower.text = payload;
-    return this.getAll();
-  }
-
-  /**
-   * @description sets message visibility on lower third screen
-   * @param status {boolean}
-   */
-  setLowerVisibility(status) {
-    this.lower.visible = status;
-    return this.getAll();
-  }
-
-  /**
-   * @description set state of onAir
-   * @param status {boolean}
-   */
-  setOnAir(status) {
-    this.onAir = status;
-    return this.getAll();
-  }
-
-  /**
-   * @description Returns feature data
-   */
-  getAll() {
-    return {
-      presenter: this.presenter,
-      public: this.public,
-      lower: this.lower,
-      onAir: this.onAir,
-    };
-  }
-}
-
-export const messageManager = new MessageService();

apps/server/src/classes/message-manager/MessageManager.ts

@@ -0,0 +1,109 @@
+import { MessageControl } from 'ontime-types';
+
+import { eventStore } from '../../stores/EventStore.js';
+
+let instance;
+
+class MessageService {
+  messages: MessageControl;
+  onAir: boolean;
+
+  constructor() {
+    if (instance) {
+      throw new Error('There can be only one');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-this-alias -- this logic is used to ensure singleton
+    instance = this;
+
+    this.messages = {
+      presenter: {
+        text: '',
+        visible: false,
+      },
+      public: {
+        text: '',
+        visible: false,
+      },
+      lower: {
+        text: '',
+        visible: false,
+      },
+    };
+    this.onAir = false;
+  }
+
+  /**
+   * @description sets message on stage timer screen
+   */
+  setTimerText(payload: string) {
+    this.messages.presenter.text = payload;
+    eventStore.set('feat-messagecontrol', { messages: this.messages });
+    return this.getAll();
+  }
+
+  /**
+   * @description sets message visibility on stage timer screen
+   */
+  setTimerVisibility(status: boolean) {
+    this.messages.presenter.visible = status;
+    eventStore.set('feat-messagecontrol', { messages: this.messages });
+    return this.getAll();
+  }
+
+  /**
+   * @description sets message on public screen
+   */
+  setPublicText(payload: string) {
+    this.messages.public.text = payload;
+    eventStore.set('feat-messagecontrol', { messages: this.messages });
+    return this.getAll();
+  }
+
+  /**
+   * @description sets message visibility on public screen
+   */
+  setPublicVisibility(status: boolean) {
+    this.messages.public.visible = status;
+    eventStore.set('feat-messagecontrol', { messages: this.messages });
+    return this.getAll();
+  }
+
+  /**
+   * @description sets message on lower third screen
+   */
+  setLowerText(payload: string) {
+    this.messages.lower.text = payload;
+    eventStore.set('feat-messagecontrol', { messages: this.messages });
+    return this.getAll();
+  }
+
+  /**
+   * @description sets message visibility on lower third screen
+   */
+  setLowerVisibility(status: boolean) {
+    this.messages.lower.visible = status;
+    eventStore.set('feat-messagecontrol', { messages: this.messages });
+    return this.getAll();
+  }
+
+  /**
+   * @description set state of onAir
+   */
+  setOnAir(status: boolean) {
+    this.onAir = status;
+    return this.getAll();
+  }
+
+  /**
+   * @description Returns feature data
+   */
+  getAll() {
+    return {
+      messages: this.messages,
+      onAir: this.onAir,
+    };
+  }
+}
+
+export const messageManager = new MessageService();

apps/server/src/classes/socket/SocketController.js

@@ -6,8 +6,7 @@ import { stringFromMillis } from '../../utils/time.js';
 import { messageManager } from '../message-manager/MessageManager.js';
 import { PlaybackService } from '../../services/PlaybackService.js';
 
-import { ADDRESS_MESSAGE_CONTROL } from './socketConfig.js';
-import { eventTimer, TimerService } from '../../services/TimerService.ts';
+import { eventTimer, TimerService } from '../../services/TimerService.js';
 import { EventLoader, eventLoader } from '../event-loader/EventLoader.js';
 
 class SocketController {
@@ -55,9 +54,7 @@ class SocketController {
       // keep track of connections
       this.numClients++;
       this._clientNames[socket.id] = getRandomName();
-      const message = `${this.numClients} Clients with new connection: ${
-        this._clientNames[socket.id]
-      }`;
+      const message = `${this.numClients} Clients with new connection: ${this._clientNames[socket.id]}`;
       this.info('CLIENT', message);
 
       // Todo: review in favour of features
@@ -78,9 +75,7 @@ class SocketController {
        */
       socket.on('disconnect', () => {
         this.numClients--;
-        const message = `${this.numClients} Clients with disconnection: ${
-          this._clientNames[socket.id]
-        }`;
+        const message = `${this.numClients} Clients with disconnection: ${this._clientNames[socket.id]}`;
         delete this._clientNames[socket.id];
         this.info('CLIENT', message);
       });
@@ -215,12 +210,10 @@ class SocketController {
           try {
             const featureData = messageManager.setOnAir(data);
             this.info('PLAYBACK', featureData.onAir ? 'Going On Air' : 'Going Off Air');
-            this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
           } catch (error) {
             this.error('RX', `Failed to parse message ${data} : ${error}`);
           }
         }
-        this.send('onAir', messageManager.onAir);
       });
 
       // Presenter message
@@ -228,16 +221,14 @@ class SocketController {
         if (typeof data !== 'string') {
           return;
         }
-        const featureData = messageManager.setTimerText(data);
-        this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setTimerText(data);
       });
 
       socket.on('set-timer-message-visible', (data) => {
         if (typeof data !== 'boolean') {
           return;
         }
-        const featureData = messageManager.setTimerVisibility(data);
-        this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setTimerVisibility(data);
       });
 
       /*******************************************/
@@ -246,16 +237,14 @@ class SocketController {
         if (typeof data !== 'string') {
           return;
         }
-        const featureData = messageManager.setPublicText(data);
-        this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setPublicText(data);
       });
 
       socket.on('set-public-message-visible', (data) => {
         if (typeof data !== 'boolean') {
           return;
         }
-        const featureData = messageManager.setPublicVisibility(data);
-        this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setPublicVisibility(data);
       });
 
       /*******************************************/
@@ -264,16 +253,14 @@ class SocketController {
         if (typeof data !== 'string') {
           return;
         }
-        const featureData = messageManager.setLowerText(data);
-        this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setLowerText(data);
       });
 
       socket.on('set-lower-message-visible', (data) => {
         if (typeof data !== 'boolean') {
           return;
         }
-        const featureData = messageManager.setLowerVisibility(data);
-        this.socket.emit(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setLowerVisibility(data);
       });
 
       /* MOLECULAR ENDPOINTS
@@ -312,8 +299,9 @@ class SocketController {
       });
 
       // 6. TIMER
-      socket.on('get-ontime-timer', () => {
-        this.broadcastTimer();
+      socket.on('get-timer', () => {
+        // TODO: Not ideal workaround
+        socket.emit('timer', eventTimer.timer);
       });
     });
   }
@@ -373,7 +361,7 @@ class SocketController {
    */
   broadcastFeatureMessageControl() {
     const featureData = messageManager.getAll();
-    this.send(ADDRESS_MESSAGE_CONTROL, featureData);
+    this.send('feat-messagecontrol', featureData);
   }
 
   /**
@@ -416,21 +404,14 @@ class SocketController {
     this.send('feat-cuesheet', featureData);
   }
 
-  /**
-   * Broadcast Timer feature
-   */
-  broadcastTimer() {
-    const featureData = eventTimer.timer;
-    this.send('ontime-timer', featureData);
-  }
-
+  // TODO: ouch, services should update the store
+  // make middleware to maintain the features OR remove the feature endpoints
   broadcastState() {
     this.broadcastFeatureRundown();
     this.broadcastFeatureMessageControl();
     this.broadcastFeaturePlaybackControl();
     this.broadcastFeatureInfo();
     this.broadcastFeatureCuesheet();
-    this.broadcastTimer();
   }
 
   /**

apps/server/src/classes/socket/socketConfig.js

@@ -1 +0,0 @@
-export const ADDRESS_MESSAGE_CONTROL = 'feat-messagecontrol';

apps/server/src/controllers/OscController.ts

@@ -4,7 +4,6 @@ import { OSCSettings } from 'ontime-types';
 import { PlaybackService } from '../services/PlaybackService.js';
 import { messageManager } from '../classes/message-manager/MessageManager.js';
 import { socketProvider } from '../classes/socket/SocketController.js';
-import { ADDRESS_MESSAGE_CONTROL } from '../classes/socket/socketConfig.js';
 
 let oscServer = null;
 
@@ -47,13 +46,11 @@ export const initiateOSC = (config: OSCSettings) => {
 
     switch (path.toLowerCase()) {
       case 'onair': {
-        const featureData = messageManager.setOnAir(true);
-        socketProvider.send(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setOnAir(true);
         break;
       }
       case 'offair': {
-        const featureData = messageManager.setOnAir(false);
-        socketProvider.send(ADDRESS_MESSAGE_CONTROL, featureData);
+        messageManager.setOnAir(false);
         break;
       }
       case 'play': {

apps/server/src/controllers/ontimeController.js

@@ -2,18 +2,18 @@ import fs from 'fs';
 import { networkInterfaces } from 'os';
 import { generateId } from 'ontime-utils';
 import { fileHandler } from '../utils/parser.js';
-import { DataProvider } from '../classes/data-provider/DataProvider.ts';
+import { DataProvider } from '../classes/data-provider/DataProvider.js';
 import { failEmptyObjects, failIsNotArray } from '../utils/routerUtils.js';
 import { mergeObject } from '../utils/parserUtils.js';
 import { PlaybackService } from '../services/PlaybackService.js';
-import { runtimeState } from '../stores/EventStore.js';
+import { eventStore } from '../stores/EventStore.js';
 import { resolveDbPath } from '../setup.js';
 
 // Create controller for GET request to '/ontime/poll'
 // Returns data for current state
 export const poll = async (req, res) => {
   try {
-    const s = runtimeState.poll();
+    const s = eventStore.poll();
     res.status(200).send(s);
   } catch (error) {
     res.status(500).send({
@@ -225,7 +225,7 @@ export const postSettings = async (req, res) => {
  * @method GET
  */
 export const getViewSettings = async (req, res) => {
-  const views = DataProvider.getViews();
+  const views = DataProvider.getViewSettings();
   res.status(200).send(views);
 };
 
@@ -240,7 +240,7 @@ export const postViewSettings = async (req, res) => {
 
   try {
     const newData = { overrideStyles: req.body.overrideStyles };
-    await DataProvider.setViews(newData);
+    await DataProvider.setViewSettings(newData);
     res.status(200).send(newData);
   } catch (error) {
     res.status(400).send(error);

apps/server/src/controllers/rundownController.js

@@ -7,7 +7,7 @@ import {
   deleteEvent,
   editEvent,
   reorderEvent,
-} from '../services/RundownService.js';
+} from '../services/RundownService.ts';
 
 // Create controller for GET request to '/eventlist'
 // Returns -

apps/server/src/index.ts

@@ -3,10 +3,7 @@ import { startDb, startIntegrations, startOSCServer, startServer } from './app.j
 async function startOntime() {
   try {
     await startDb();
-
-    const loaded = await startServer();
-    console.log(loaded);
-
+    await startServer();
     await startOSCServer();
     await startIntegrations();
   } catch (error) {

apps/server/src/models/dataModel.ts

@@ -2,7 +2,7 @@ import { DatabaseModel } from 'ontime-types';
 
 export const dbModel: DatabaseModel = {
   rundown: [],
-  event: {
+  eventData: {
     title: '',
     publicUrl: '',
     publicInfo: '',
@@ -18,7 +18,7 @@ export const dbModel: DatabaseModel = {
     pinCode: null,
     timeFormat: '24',
   },
-  views: {
+  viewSettings: {
     overrideStyles: false,
   },
   aliases: [],

apps/server/src/routes/eventDataRouter.js

@@ -2,8 +2,8 @@ import express from 'express';
 export const router = express.Router();
 
 // import event controller
-import { getEvent, postEvent } from '../controllers/eventController.js';
-import { eventSanitizer } from '../controllers/eventController.validate.js';
+import { getEvent, postEvent } from '../controllers/eventDataController.js';
+import { eventSanitizer } from '../controllers/eventDataController.validate.js';
 
 // create route between controller and 'GET /event' endpoint
 router.get('/', getEvent);

apps/server/src/services/PlaybackService.js

@@ -3,7 +3,8 @@
  */
 import { socketProvider } from '../classes/socket/SocketController.js';
 import { eventLoader, EventLoader } from '../classes/event-loader/EventLoader.js';
-import { eventTimer, TimerService } from './TimerService.ts';
+import { eventTimer, TimerService } from './TimerService.js';
+import { eventStore } from '../stores/EventStore.js';
 
 /**
  * Service manages playback status of app
@@ -26,7 +27,7 @@ export class PlaybackService {
       eventTimer.load(event);
       success = true;
     }
-    socketProvider.broadcastState();
+    eventStore.broadcast();
     return success;
   }
 
@@ -123,7 +124,6 @@ export class PlaybackService {
       const newState = eventTimer.playback;
       socketProvider.info('PLAYBACK', `Play Mode ${newState.toUpperCase()}`);
     }
-    socketProvider.broadcastState();
   }
 
   /**
@@ -135,7 +135,6 @@ export class PlaybackService {
       const newState = eventTimer.playback;
       socketProvider.info('PLAYBACK', `Play Mode ${newState.toUpperCase()}`);
     }
-    socketProvider.broadcastState();
   }
 
   /**
@@ -148,7 +147,6 @@ export class PlaybackService {
       const newState = eventTimer.playback;
       socketProvider.info('PLAYBACK', `Play Mode ${newState.toUpperCase()}`);
     }
-    socketProvider.broadcastState();
   }
 
   /**
@@ -158,7 +156,6 @@ export class PlaybackService {
     if (eventLoader.selectedEventId) {
       this.loadById(eventLoader.selectedEventId);
     }
-    socketProvider.broadcastState();
   }
 
   /**
@@ -186,7 +183,6 @@ export class PlaybackService {
 
       const newState = eventTimer.playback;
       socketProvider.info('PLAYBACK', `Play Mode ${newState.toUpperCase()}`);
-      socketProvider.broadcastState();
     }
   }
 
@@ -200,6 +196,5 @@ export class PlaybackService {
       eventTimer.delay(delayInMs);
       socketProvider.info('PLAYBACK', `Added ${delayTime} min delay`);
     }
-    socketProvider.broadcastState();
   }
 }

apps/server/src/services/RundownService.ts

@@ -1,21 +1,16 @@
+import { OntimeBaseEvent, OntimeBlock, OntimeDelay, OntimeEvent } from 'ontime-types';
 import { generateId } from 'ontime-utils';
-import { DataProvider } from '../classes/data-provider/DataProvider.ts';
-import {
-  block as blockDef,
-  delay as delayDef,
-  event as eventDef,
-} from '../models/eventsDefinition.js';
+import { DataProvider } from '../classes/data-provider/DataProvider.js';
+import { block as blockDef, delay as delayDef, event as eventDef } from '../models/eventsDefinition.js';
 import { MAX_EVENTS } from '../settings.js';
 import { EventLoader, eventLoader } from '../classes/event-loader/EventLoader.js';
-import { eventTimer } from './TimerService.ts';
-import { socketProvider } from '../classes/socket/SocketController.js';
+import { eventTimer } from './TimerService.js';
+import { eventStore } from '../stores/EventStore.js';
 
 /**
- *
- * @param affectedIds
- * @returns boolean
+ * Checks if a list of IDs is in the current selection
  */
-const affectedLoaded = (affectedIds) => {
+const affectedLoaded = (affectedIds: string[]) => {
   const now = eventLoader.selectedEventId;
   const nowPublic = eventLoader.selectedPublicEventId;
   const next = eventLoader.nextEventId;
@@ -28,6 +23,9 @@ const affectedLoaded = (affectedIds) => {
   );
 };
 
+/**
+ * Checks if timer replaces the loaded next
+ */
 const isNewNext = () => {
   const timedEvents = EventLoader.getTimedEvents();
   const now = eventLoader.selectedEventId;
@@ -66,10 +64,9 @@ const isNewNext = () => {
 };
 
 /**
- * updates timer object
- * @param {array} [affectedIds]
+ * Updates timer object
  */
-export function updateTimer(affectedIds) {
+export function updateTimer(affectedIds?: string[]) {
   const runningEventId = eventLoader.selectedEventId;
 
   if (runningEventId === null) {
@@ -121,18 +118,18 @@ export async function addEvent(eventData) {
     throw new Error(`ERROR: Reached limit number of ${MAX_EVENTS} events`);
   }
 
-  let newEvent = {};
+  let newEvent: Partial<OntimeBaseEvent> = {};
   const id = generateId();
 
   switch (eventData.type) {
     case 'event':
-      newEvent = { ...eventDef, ...eventData, id };
+      newEvent = { ...eventDef, ...eventData, id } as Partial<OntimeEvent>;
       break;
     case 'delay':
-      newEvent = { ...delayDef, ...eventData, id };
+      newEvent = { ...delayDef, ...eventData, id } as Partial<OntimeDelay>;
       break;
     case 'block':
-      newEvent = { ...blockDef, ...eventData, id };
+      newEvent = { ...blockDef, ...eventData, id } as Partial<OntimeBlock>;
       break;
   }
 
@@ -148,7 +145,7 @@ export async function addEvent(eventData) {
     throw new Error(error);
   }
   updateTimer([id]);
-  socketProvider.broadcastState();
+  eventStore.broadcast();
   return newEvent;
 }
 
@@ -160,7 +157,7 @@ export async function editEvent(eventData) {
   }
   const newEvent = await DataProvider.updateEventById(eventId, eventData);
   updateTimer([eventId]);
-  socketProvider.broadcastState();
+  eventStore.broadcast();
   return newEvent;
 }
 
@@ -172,7 +169,7 @@ export async function editEvent(eventData) {
 export async function deleteEvent(eventId) {
   await DataProvider.deleteEvent(eventId);
   updateTimer([eventId]);
-  socketProvider.broadcastState();
+  eventStore.broadcast();
 }
 
 /**
@@ -182,7 +179,7 @@ export async function deleteEvent(eventId) {
 export async function deleteAllEvents() {
   await DataProvider.clearRundown();
   updateTimer();
-  socketProvider.broadcastState();
+  eventStore.broadcast();
 }
 
 /**
@@ -263,5 +260,5 @@ export async function applyDelay(eventId) {
   // update rundown
   await DataProvider.setRundown(rundown);
   updateTimer();
-  socketProvider.broadcastState();
+  eventStore.broadcast();
 }

apps/server/src/services/TimerService.ts

@@ -1,6 +1,6 @@
 import { TimerLifeCycle } from 'ontime-types';
 
-import { runtimeState } from '../stores/EventStore.js';
+import { eventStore } from '../stores/EventStore.js';
 import { PlaybackService } from './PlaybackService.js';
 import { updateRoll } from './rollUtils.js';
 import { DAY_TO_MS } from '../utils/time.js';
@@ -9,9 +9,9 @@ import { integrationService } from './integration-service/IntegrationService.js'
 export class TimerService {
   private readonly _interval: NodeJS.Timer;
 
-  private playback: string;
+  playback: string;
 
-  private loadedTimerId: null;
+  loadedTimerId: null;
   private _pausedInterval: number;
   private _pausedAt: number | null;
   private _secondaryTarget: number | null;
@@ -163,8 +163,8 @@ export class TimerService {
    * @private
    */
   _onLoad() {
-    runtimeState.set('playback', this.playback);
-    runtimeState.set('ontime-timer', this.timer);
+    eventStore.set('playback', this.playback);
+    eventStore.set('timer', this.timer);
     integrationService.dispatch(TimerLifeCycle.onLoad);
   }
 
@@ -198,8 +198,8 @@ export class TimerService {
    * @private
    */
   _onStart() {
-    runtimeState.set('playback', this.playback);
-    runtimeState.set('ontime-timer', this.timer);
+    eventStore.set('playback', this.playback);
+    eventStore.set('timer', this.timer);
     integrationService.dispatch(TimerLifeCycle.onStart);
   }
 
@@ -215,8 +215,8 @@ export class TimerService {
   }
 
   _onPause() {
-    runtimeState.set('playback', this.playback);
-    runtimeState.set('ontime-timer', this.timer);
+    eventStore.set('playback', this.playback);
+    eventStore.set('timer', this.timer);
     integrationService.dispatch(TimerLifeCycle.onPause);
   }
 
@@ -230,8 +230,8 @@ export class TimerService {
   }
 
   _onStop() {
-    runtimeState.set('playback', this.playback);
-    runtimeState.set('ontime-timer', this.timer);
+    eventStore.set('playback', this.playback);
+    eventStore.set('timer', this.timer);
     integrationService.dispatch(TimerLifeCycle.onStop);
   }
 
@@ -318,14 +318,14 @@ export class TimerService {
   }
 
   _onUpdate() {
-    runtimeState.set('playback', this.playback);
-    runtimeState.set('ontime-timer', this.timer);
+    eventStore.set('playback', this.playback);
+    eventStore.set('timer', this.timer);
     integrationService.dispatch(TimerLifeCycle.onUpdate);
   }
 
   _onFinish() {
-    runtimeState.set('playback', this.playback);
-    runtimeState.set('ontime-timer', this.timer);
+    eventStore.set('playback', this.playback);
+    eventStore.set('timer', this.timer);
     integrationService.dispatch(TimerLifeCycle.onFinish);
   }
 

apps/server/src/services/integration-service/IntegrationService.ts

@@ -1,5 +1,5 @@
 import IIntegration, { TimerLifeCycleKey } from './IIntegration.js';
-import { runtimeState } from '../../stores/EventStore.js';
+import { eventStore } from '../../stores/EventStore.js';
 
 class IntegrationService {
   private integrations: IIntegration[];
@@ -17,7 +17,7 @@ class IntegrationService {
   }
 
   dispatch(action: TimerLifeCycleKey) {
-    const state = runtimeState.poll();
+    const state = eventStore.poll();
     this.integrations.forEach((integration) => {
       integration.dispatch(action, state);
     });

apps/server/src/services/rollUtils.ts

@@ -1,16 +1,12 @@
 /**
  * Utility variable: 24 hour in milliseconds .
- * @type {number}
  */
 export const DAY_TO_MS = 86400000;
 
 /**
- * @description handle events that span over midnight
- * @param {number} start - When does the event start
- * @param {number} end  - When does the event end
- * @returns {number} normalised time
+ * handle events that span over midnight
  */
-export const normaliseEndTime = (start, end) => (end < start ? end + DAY_TO_MS : end);
+export const normaliseEndTime = (start: number, end: number) => (end < start ? end + DAY_TO_MS : end);
 
 /**
  * @description Sorts an array of objects by given property
@@ -45,15 +41,15 @@ export const replacePlaceholder = (str, values) => {
  * @param timeNow
  * @returns {{}}
  */
-export const getRollTimers = (rundown, timeNow) => {
-  let nowIndex = null; // index of event now
-  let nowId = null; // id of event now
-  let publicIndex = null; // index of public event now
+export const getRollTimers = (rundown, timeNow: number) => {
+  let nowIndex: number | null = null; // index of event now
+  let nowId: string | null = null; // id of event now
+  let publicIndex: string | null = null; // index of public event now
   let publicTime = -1;
-  let nextIndex = null; // index of next event
-  let publicNextIndex = null; // index of next public event
-  let timeToNext = null; // counter: time for next event
-  let publicTimeToNext = null; // counter: time for next public event
+  let nextIndex: number | null = null; // index of next event
+  let publicNextIndex: number | null = null; // index of next public event
+  let timeToNext: number | null = null; // counter: time for next event
+  let publicTimeToNext: number | null = null; // counter: time for next public event
   let timers = null;
 
   // Order events by startTime
@@ -171,8 +167,7 @@ export const getRollTimers = (rundown, timeNow) => {
  * @returns {object} object with selection variables
  */
 export const updateRoll = (currentTimers) => {
-  const { selectedEventId, current, _finishAt, clock, secondaryTimer, _secondaryTarget } =
-    currentTimers;
+  const { selectedEventId, current, _finishAt, clock, secondaryTimer, _secondaryTarget } = currentTimers;
 
   // timers
   let updatedTimer = current;

apps/server/src/stores/EventStore.js

@@ -5,7 +5,7 @@ const store = {};
 /**
  * A runtime store that broadcasts its payload
  */
-export const runtimeState = {
+export const eventStore = {
   get(key) {
     return store[key];
   },
@@ -16,4 +16,8 @@ export const runtimeState = {
   poll() {
     return store;
   },
+  broadcast() {
+    socketProvider.send(store);
+    socketProvider.broadcastState();
+  },
 };

apps/server/src/utils/__tests__/parser.tests.js

@@ -2,7 +2,7 @@ import { vi } from 'vitest';
 import { dbModel } from '../../models/dataModel.js';
 import { parseExcel, parseJson, validateEvent } from '../parser.js';
 import { makeString, validateDuration } from '../parserUtils.js';
-import { parseAliases, parseUserFields, parseViews } from '../parserFunctions.js';
+import { parseAliases, parseUserFields, parseViewSettings } from '../parserFunctions.js';
 
 describe('test json parser with valid def', () => {
   const testData = {
@@ -829,7 +829,7 @@ describe('test views import', () => {
         overrideStyles: true,
       },
     };
-    const parsed = parseViews(testData);
+    const parsed = parseViewSettings(testData);
     expect(parsed).toStrictEqual(testData.views);
   });
 
@@ -841,7 +841,7 @@ describe('test views import', () => {
         version: 2,
       },
     };
-    const parsed = parseViews(testData, true);
+    const parsed = parseViewSettings(testData, true);
     expect(parsed).toStrictEqual(dbModel.views);
   });
 });

apps/server/src/utils/parser.js

@@ -6,13 +6,13 @@ import { dbModel } from '../models/dataModel.js';
 import { deleteFile, makeString, validateDuration } from './parserUtils.js';
 import {
   parseAliases,
-  parseEvent,
+  parseEventData,
   parseHttp,
   parseOsc,
   parseRundown,
   parseSettings,
   parseUserFields,
-  parseViews,
+  parseViewSettings,
 } from './parserFunctions.js';
 import { parseExcelDate } from './time.js';
 
@@ -238,7 +238,7 @@ export const parseExcel = async (excelData) => {
     });
   return {
     rundown,
-    event: eventData,
+    eventData: eventData,
     settings: {
       app: 'ontime',
       version: 2,
@@ -265,11 +265,11 @@ export const parseJson = async (jsonData, enforce = false) => {
   // parse Events
   returnData.rundown = parseRundown(jsonData);
   // parse Event
-  returnData.event = parseEvent(jsonData, enforce);
+  returnData.eventData = parseEventData(jsonData, enforce);
   // Settings handled partially
   returnData.settings = parseSettings(jsonData, enforce);
   // View settings handled partially
-  returnData.views = parseViews(jsonData, enforce);
+  returnData.viewSettings = parseViewSettings(jsonData, enforce);
   // Import OSC settings if any
   returnData.osc = parseOsc(jsonData, enforce);
   // Import HTTP settings if any
@@ -358,7 +358,7 @@ export const fileHandler = async (file) => {
         const dataFromExcel = await parseExcel(excelData.data);
         res.data = {};
         res.data.rundown = parseRundown(dataFromExcel);
-        res.data.event = parseEvent(dataFromExcel, true);
+        res.data.eventData = parseEventData(dataFromExcel, true);
         res.data.userFields = parseUserFields(dataFromExcel);
         res.message = 'success';
       } else {

apps/server/src/utils/parserFunctions.ts

@@ -64,26 +64,26 @@ export const parseRundown = (data) => {
  * @param {boolean} enforce - whether to create a definition if one is missing
  * @returns {object} - event object data
  */
-export const parseEvent = (data, enforce) => {
-  let newEvent = {};
-  if ('event' in data) {
+export const parseEventData = (data, enforce) => {
+  let newEventData = {};
+  if ('eventData' in data) {
     console.log('Found event data, importing...');
-    const e = data.event;
+    const e = data.eventData;
     // filter known properties and write to db
-    newEvent = {
-      ...dbModel.event,
-      title: e.title || dbModel.event.title,
-      publicUrl: e.publicUrl || dbModel.event.publicUrl,
-      publicInfo: e.publicInfo || dbModel.event.publicInfo,
-      backstageUrl: e.backstageUrl || dbModel.event.backstageUrl,
-      backstageInfo: e.backstageInfo || dbModel.event.backstageInfo,
-      endMessage: e.endMessage || dbModel.event.endMessage,
+    newEventData = {
+      ...dbModel.eventData,
+      title: e.title || dbModel.eventData.title,
+      publicUrl: e.publicUrl || dbModel.eventData.publicUrl,
+      publicInfo: e.publicInfo || dbModel.eventData.publicInfo,
+      backstageUrl: e.backstageUrl || dbModel.eventData.backstageUrl,
+      backstageInfo: e.backstageInfo || dbModel.eventData.backstageInfo,
+      endMessage: e.endMessage || dbModel.eventData.endMessage,
     };
   } else if (enforce) {
-    newEvent = { ...dbModel.event };
+    newEventData = { ...dbModel.eventData };
     console.log(`Created event object in db`);
   }
-  return newEvent;
+  return newEventData;
 };
 
 /**
@@ -127,14 +127,14 @@ export const parseSettings = (data, enforce) => {
  * @param {boolean} enforce - whether to create a definition if one is missing
  * @returns {object} - event object data
  */
-export const parseViews = (data, enforce) => {
+export const parseViewSettings = (data, enforce) => {
   let newViews = {};
-  if ('views' in data) {
+  if ('viewSettings' in data) {
     console.log('Found view definition, importing...');
-    const v = data.views;
+    const v = data.viewSettings;
 
     const viewSettings = {
-      overrideStyles: v.overrideStyles ?? dbModel.views.overrideStyles,
+      overrideStyles: v.overrideStyles ?? dbModel.viewSettings.overrideStyles,
     };
 
     // write to db
@@ -142,8 +142,8 @@ export const parseViews = (data, enforce) => {
       ...viewSettings,
     };
   } else if (enforce) {
-    newViews = dbModel.views;
-    console.log(`Created view object in db`);
+    newViews = dbModel.viewSettings;
+    console.log(`Created viewSettings object in db`);
   }
   return newViews;
 };