Merge branch 'master' into feat/http-integration

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

@@ -2,7 +2,16 @@
  * Class Event Provider is a mediator for handling the local db
  * and adds logic specific to ontime data
  */
-import { ProjectData, OntimeRundown, ViewSettings } from 'ontime-types';
+import {
+  ProjectData,
+  OntimeRundown,
+  ViewSettings,
+  DatabaseModel,
+  OSCSettings,
+  UserFields,
+  Alias,
+  Settings,
+} from 'ontime-types';
 
 import { data, db } from '../../modules/loadDb.js';
 import { safeMerge } from './DataProvider.utils.js';
@@ -37,7 +46,6 @@ export class DataProvider {
 
   static async clearRundown() {
     data.rundown = [];
-    // @ts-expect-error -- not sure how to type, this is library side
     await db.write();
   }
 
@@ -45,7 +53,7 @@ export class DataProvider {
     return data.settings;
   }
 
-  static async setSettings(newData) {
+  static async setSettings(newData: Settings) {
     data.settings = { ...newData };
     await this.persist();
   }
@@ -62,7 +70,7 @@ export class DataProvider {
     return data.aliases;
   }
 
-  static async setAliases(newData) {
+  static async setAliases(newData: Alias[]) {
     data.aliases = newData;
     await this.persist();
   }
@@ -80,12 +88,12 @@ export class DataProvider {
     await this.persist();
   }
 
-  static async setUserFields(newData) {
+  static async setUserFields(newData: UserFields) {
     data.userFields = { ...newData };
     await this.persist();
   }
 
-  static async setOsc(newData) {
+  static async setOsc(newData: OSCSettings) {
     data.osc = { ...newData };
     await this.persist();
   }
@@ -100,11 +108,10 @@ export class DataProvider {
   }
 
   static async persist() {
-    // @ts-expect-error -- not sure how to type, this is library side
     await db.write();
   }
 
-  static async mergeIntoData(newData) {
+  static async mergeIntoData(newData: Partial<DatabaseModel>) {
     const mergedData = safeMerge(data, newData);
     data.project = mergedData.project;
     data.settings = mergedData.settings;

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

@@ -1,10 +1,12 @@
+import { DatabaseModel } from 'ontime-types';
+
 /**
  * Merges two data objects
  * @param {object} existing
  * @param {object} newData
  */
-export function safeMerge(existing, newData) {
-  const { rundown, project, settings, viewSettings, osc, http, aliases, userFields } = newData || {};
+export function safeMerge(existing: DatabaseModel, newData: Partial<DatabaseModel>) {
+  const { rundown, project, settings, viewSettings, osc, aliases, userFields } = newData || {};
   return {
     ...existing,
     rundown: rundown ?? existing.rundown,
@@ -32,6 +34,5 @@ export function safeMerge(existing, newData) {
           : {}),
       },
     },
-    http: { ...existing.http, ...http },
   };
 }

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

@@ -1,3 +1,4 @@
+import { Alias, DatabaseModel, OntimeRundown, Settings } from 'ontime-types';
 import { safeMerge } from '../DataProvider.utils.js';
 
 describe('safeMerge', () => {
@@ -5,13 +6,15 @@ describe('safeMerge', () => {
     rundown: [],
     project: {
       title: 'existing title',
+      description: 'existing description',
       publicUrl: 'existing public URL',
       backstageUrl: 'existing backstageUrl',
+      publicInfo: 'existing backstageInfo',
       backstageInfo: 'existing backstageInfo',
     },
     settings: {
       app: 'ontime',
-      version: 2,
+      version: '2.0.0',
       serverPort: 4001,
       editorKey: null,
       operatorKey: null,
@@ -42,12 +45,7 @@ describe('safeMerge', () => {
         onFinish: [],
       },
     },
-    http: {
-      enabled: true,
-      user: null,
-      pwd: null,
-    },
-  };
+  } as DatabaseModel;
 
   it('returns existing data if new data is not provided', () => {
     const mergedData = safeMerge(existing, undefined);
@@ -56,7 +54,7 @@ describe('safeMerge', () => {
 
   it('merges the rundown key', () => {
     const newData = {
-      rundown: [{ name: 'item 1' }, { name: 'item 2' }],
+      rundown: [{ title: 'item 1' }, { title: 'item 2' }] as OntimeRundown,
     };
     const mergedData = safeMerge(existing, newData);
     expect(mergedData.rundown).toEqual(newData.rundown);
@@ -69,9 +67,11 @@ describe('safeMerge', () => {
         publicInfo: 'new public info',
       },
     };
+    // @ts-expect-error -- just testing
     const mergedData = safeMerge(existing, newData);
     expect(mergedData.project).toEqual({
       title: 'new title',
+      description: 'existing description',
       publicUrl: 'existing public URL',
       publicInfo: 'new public info',
       backstageUrl: 'existing backstageUrl',
@@ -84,12 +84,12 @@ describe('safeMerge', () => {
       settings: {
         serverPort: 3000,
         language: 'pt',
-      },
+      } as Settings,
     };
     const mergedData = safeMerge(existing, newData);
     expect(mergedData.settings).toEqual({
       app: 'ontime',
-      version: 2,
+      version: '2.0.0',
       serverPort: 3000,
       operatorKey: null,
       editorKey: null,
@@ -113,6 +113,7 @@ describe('safeMerge', () => {
         },
       },
     };
+    //@ts-expect-error -- testing partial merge
     const mergedData = safeMerge(existing, newData);
     expect(mergedData.osc).toEqual({
       portIn: 7777,
@@ -140,7 +141,7 @@ describe('safeMerge', () => {
   it('should merge the aliases key when present', () => {
     const existingData = {
       rundown: [],
-      event: {
+      project: {
         title: '',
         publicUrl: '',
         publicInfo: '',
@@ -149,7 +150,7 @@ describe('safeMerge', () => {
       },
       settings: {
         app: 'ontime',
-        version: 2,
+        version: '2.0.0',
         serverPort: 4001,
         operatorKey: null,
         editorKey: null,
@@ -188,23 +189,13 @@ describe('safeMerge', () => {
           onFinish: [],
         },
       },
-      http: {
-        user: null,
-        pwd: null,
-        messages: {
-          onLoad: [],
-          onStart: [],
-          onUpdate: [],
-          onPause: [],
-          onStop: [],
-          onFinish: [],
-        },
-        enabled: true,
-      },
-    };
+    } as DatabaseModel;
 
     const newData = {
-      aliases: ['alias1', 'alias2'],
+      aliases: [
+        { enabled: true, alias: 'alias1', pathAndParams: '' },
+        { enabled: true, alias: 'alias2', pathAndParams: '' },
+      ] as Alias[],
     };
 
     const mergedData = safeMerge(existingData, newData);
@@ -235,6 +226,7 @@ describe('safeMerge', () => {
       user3: 'David',
     };
 
+    //@ts-expect-error -- testing partial merge
     const result = safeMerge(existing, newData);
     expect(result.userFields).toEqual(expected);
   });