hotfix ci (#594)

* ci: upgrade pnpm

* version bump

.eslintignore

@@ -0,0 +1 @@
+ "ONTIME_VERSION.js"

.eslintrc

@@ -1,4 +1,5 @@
 {
+  "root": true,
   "parserOptions": {
     "ecmaVersion": 2020
   },
@@ -6,8 +7,16 @@
     "es6": true,
     "jest": true
   },
+  "parser": "@typescript-eslint/parser",
   "extends": [
-    "eslint:recommended"
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "eslint-config-prettier"
+  ],
+  "plugins": [
+    "@typescript-eslint",
+    "prettier"
   ],
   "overrides": [
     {
@@ -21,6 +30,33 @@
     }
   ],
   "rules": {
-    "no-console": "warn"
+    "no-useless-concat": "warn",
+    "prefer-template": "warn",
+    "no-console": [
+      "warn",
+      {
+        "allow": [
+          "warn",
+          "error"
+        ]
+      }
+    ],
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_",
+        "destructuredArrayIgnorePattern": "^_",
+        "varsIgnorePattern": "^_"
+      }
+    ],
+    "prettier/prettier": [
+      "warn",
+      {
+        "endOfLine": "auto"
+      }
+    ]
   }
 }

.github/workflows/build_docker_v2.yml

@@ -23,9 +23,9 @@ jobs:
         version: 16.16.0
 
     - name: Setup pnpm
-      uses: pnpm/action-setup@v2.2.4
+      uses: pnpm/action-setup@v2
       with:
-        version: 7.26.3
+        version: 8
 
     - name: Install dependencies
       run: pnpm install --frozen-lockfile

.github/workflows/build_v2.yml

@@ -17,9 +17,9 @@ jobs:
           node-version: 16
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2.2.4
+        uses: pnpm/action-setup@v2
         with:
-          version: 7.26.3
+          version: 8
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
@@ -52,9 +52,9 @@ jobs:
           node-version: 16
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2.2.4
+        uses: pnpm/action-setup@v2
         with:
-          version: 7.26.3
+          version: 8
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
@@ -85,9 +85,9 @@ jobs:
           node-version: 16
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2.2.4
+        uses: pnpm/action-setup@v2
         with:
-          version: 7.26.3
+          version: 8
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile

.github/workflows/test_v2.yml

@@ -20,23 +20,47 @@ jobs:
           node-version: 16
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2.2.4
+        uses: pnpm/action-setup@v2
         with:
-          version: 7.26.3
+          version: 8
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
+      # Run code quality per package
+      - name: React - Run linter
+        if: always()
+        run: pnpm lint
+        working-directory: ./apps/client
+
+      - name: Server - Run linter
+        if: always()
+        run: pnpm lint
+        working-directory: ./apps/server
+
+      - name: Utils - Run linter
+        if: always()
+        run: pnpm lint
+        working-directory: ./packages/utils
+
+      - name: Types - Run linter
+        if: always()
+        run: pnpm lint
+        working-directory: ./packages/types
+
       # We choose to run tests separately
       - name: React - Run unit tests
+        if: always()
         run: pnpm test:pipeline
         working-directory: ./apps/client
 
       - name: Server - Run unit tests
+        if: always()
         run: pnpm test:pipeline
         working-directory: ./apps/server
 
       - name: Utils - Run unit tests
+        if: always()
         run: pnpm test:pipeline
         working-directory: ./packages/utils
 
@@ -52,9 +76,9 @@ jobs:
           node-version: 16
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2.2.4
+        uses: pnpm/action-setup@v2
         with:
-          version: 7.26.3
+          version: 8
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+pnpm lint

.prettierignore

@@ -0,0 +1,10 @@
+build
+coverage
+dist
+node_modules
+
+playwright-report
+
+**/*.toml
+**/*.yml
+**/*.json

.prettierrc

@@ -1,4 +1,5 @@
 {
+  "endOfLine": "lf",
   "trailingComma": "all",
   "tabWidth": 2,
   "semi": true,

DEVELOPMENT.md

@@ -56,6 +56,8 @@ E2E tests are in a separate package. On running, [playwright](https://playwright
 webserver to test against
 These tests also run against a separate version of the DB (test-db)
 
+Before running the E2E, you should first build the project with `pnpm build:local`.
+
 You can run playwright tests from project root with `pnpm e2e`
 
 When writing tests, it can be handy to run playwright in interactive mode with `pnpm e2e:i`. You would need to manually

README.md

@@ -17,7 +17,8 @@ Ontime is an application for creating and managing event running order and timer
 The user inputs a list of events along with scheduling and event information.
 This will then populate a series of screens which are available to be rendered by any device in the Network.
 
-This makes for a simple and cheap way to distribute over a venue using a network infrastructure instead of video outputs.
+This makes for a simple and cheap way to distribute over a venue using a network infrastructure instead of video
+outputs.
 
 ![App Window](https://github.com/cpvalente/ontime/blob/master/.github/aux-images/app.png)
 
@@ -50,6 +51,7 @@ IP.ADDRESS:4001/public     > Public / Foyer view
 IP.ADDRESS:4001/lower      > Lower Thirds
 IP.ADDRESS:4001/studio     > Studio Clock
 ```
+
 ```
 For management views
 -------------------------------------------------------------
@@ -63,14 +65,14 @@ More documentation is available [in our docs](https://ontime.gitbook.io)
 
 - [x] Distribute data over network and render it in the browser
 - [x] Different screen types
-    - Stage Timer
+  - Stage Timer
-    - Minimal Timer
+  - Minimal Timer
-    - Clock
+  - Clock
-    - Backstage Info
+  - Backstage Info
-    - Public Info
+  - Public Info
-    - Studio Clock
+  - Studio Clock
-    - Countdown
+  - Countdown
-    - [Make your own?](#make-your-own-viewer)
+  - [Make your own?](#make-your-own-viewer)
 - [x] Configurable Lower Thirds
 - [x] Collaborative editing with the cuesheet view
 - [x] Send live messages to different screen types
@@ -83,17 +85,19 @@ More documentation is available [in our docs](https://ontime.gitbook.io)
 - [x] Roll mode: run standalone using the system clock
 - [x] [Headless run](#headless-run): run server in a separate machine, configure from a browser locally
 - [x] [Countdown to anything!](https://ontime.gitbook.io/v2/views/countdown): have
-  a countdown to any scheduled event
+      a countdown to any scheduled event
-- [x] Multi-platform  (available on Windows, MacOS and Linux)
+- [x] Multi-platform (available on Windows, MacOS and Linux)
 - [x] [Companion integration](https://bitfocus.io/connections/getontime-ontime)
 
 ## Unopinionated
 
 We want Ontime to be unique by targeting freelancers instead of roles.
 
-We believe most freelancers work in different fields and we want to give you a tool that you can leverage across your many environments and workflows.
+We believe most freelancers work in different fields and we want to give you a tool that you can leverage across your
+many environments and workflows.
 
-We are not interested in forcing workflows and have made Ontime so, it is flexible to whichever way you would like to work.
+We are not interested in forcing workflows and have made Ontime so, it is flexible to whichever way you would like to
+work.
 
 ## Rich APIs for workflow integrations
 
@@ -113,7 +117,8 @@ Taking advantage of the integrations, we currently use Ontime with:
 
 Ontime broadcasts its data over WebSockets. This allows you to consume its data outside the application.
 
-Writing a new view for the browser can be done with basic knowledge of HTML + CSS + Javascript (or any other language that can run in the browser).
+Writing a new view for the browser can be done with basic knowledge of HTML + CSS + Javascript (or any other language
+that can run in the browser).
 <br />
 See [this repository](https://github.com/cpvalente/ontime-viewer-template-v2) with a small template on
 how to get you started and read the docs about
@@ -121,26 +126,11 @@ the [Websocket API](https://ontime.gitbook.io/v2/control-and-feedback/ontime-api
 
 ### Headless run️
 
-You can self-host and run Ontime in a docker image. The run command will:
+You can self-host and run Ontime in a docker image.
 
-- expose the necessary ports (listed in the Dockerfile)
+The docker image along with documentation is [available Docker Hub at getontime/ontime](https://hub.docker.com/r/getontime/ontime)
-- mount a local file to persist your data (in the example: ````$(pwd)/local-data````)
-- the image name __getontime/ontime__
 
-The docker image is
+If you want to run this image in a Raspberry Pi, please see [the docs](https://ontime.gitbook.io/v2/additional-notes/use-in-raspberry-pi)
-in [available Docker Hub at getontime/ontime](https://hub.docker.com/r/getontime/ontime)
-
-```bash
-docker pull getontime/ontime
-```
-
-and use the included docker compose to get started
-
-```bash
-docker-compose up
-```
-
-Related information available [in the docs](https://ontime.gitbook.io/v2/additional-notes/use-in-raspberry-pi)
 
 ## Roadmap
 
@@ -148,7 +138,8 @@ Related information available [in the docs](https://ontime.gitbook.io/v2/additio
 
 Several features are planned in the roadmap, and we continuously adjust this to match how users interact with the app.
 <br />
-Have an idea? Reach out via [email](mail@getontime.no) or [open an issue](https://github.com/cpvalente/ontime/issues/new)
+Have an idea? Reach out via [email](mail@getontime.no)
+or [open an issue](https://github.com/cpvalente/ontime/issues/new)
 
 ### Issues
 
@@ -159,21 +150,20 @@ Found a bug? [Open an issue](https://github.com/cpvalente/ontime/issues/new).
 
 When installing the app you would see warning screens from the Operating System like:
 
-```Microsoft Defender SmartScreen prevented an unrecognised app from starting. Running this app might put your PC at risk.```
+`Microsoft Defender SmartScreen prevented an unrecognised app from starting. Running this app might put your PC at risk.`
 
 or
 
-```Ontime can't be opened because it is from an unidentified developer```
+`Ontime can't be opened because it is from an unidentified developer`
 
 or in Linux
 
-```Could Not Display "ontime-linux.AppImage```
+`Could Not Display "ontime-linux.AppImage`
 
 You can circumvent this by allowing the execution of the app manually.
 
 - In Windows: click more and select "Run Anyway"
-- in macOS: after attempting to run the installer, navigate to System Preferences ->  Security &
+- in macOS: the solution in macOS is different across versions, please refer to the [apple documentation](https://support.apple.com/en-gb/guide/mac-help/mh40616/mac)
-  Privacy and allow the execution of the app
 - In Linux: right-click the AppImage file -> Properties -> Permissions -> select Allow Executing
   File as a Program
 
@@ -185,6 +175,7 @@ please [open an issue](https://github.com/cpvalente/ontime/issues/new)
 #### Safari
 
 There are known issues with Safari versions lower than 13:
+
 - Spacing and text styles might have small inconsistencies
 - Table view does not work
 
@@ -194,7 +185,8 @@ There is no plan for any further work on this.
 
 Looking to contribute? All types of help are appreciated, from coding to testing and feature specification.
 <br /><br />
-If you are a developer and would like to contribute with some code, please open an issue to discuss before opening a Pull Request.
+If you are a developer and would like to contribute with some code, please open an issue to discuss before opening a
+Pull Request.
 <br />
 Information about the project setup can be found in the [development documentation](./DEVELOPMENT.md)
 

apps/client/.eslintrc

@@ -8,34 +8,18 @@
     "browser": true,
     "node": true
   },
-  "parser": "@typescript-eslint/parser",
   "extends": [
-    "eslint:recommended",
     "plugin:react/recommended",
     "plugin:react-hooks/recommended",
-    "plugin:@typescript-eslint/recommended",
+    "plugin:@tanstack/eslint-plugin-query/recommended"
-    "eslint-config-prettier",
-    "plugin:@tanstack/eslint-plugin-query/recommended",
-    "prettier"
   ],
   "plugins": [
     "react",
     "testing-library",
     "simple-import-sort",
-    "@tanstack/query",
+    "@tanstack/query"
-    "@typescript-eslint",
-    "prettier"
   ],
   "rules": {
-    "@typescript-eslint/no-non-null-assertion": "warn",
-    "prettier/prettier": [
-      "error",
-      {
-        "endOfLine": "auto"
-      }
-    ],
-    "no-useless-concat": "warn",
-    "prefer-template": "warn",
     "react/jsx-no-bind": [
       "error",
       {

apps/client/.prettierrc

@@ -1,4 +1,5 @@
 {
+  "endOfLine": "lf",
   "trailingComma": "all",
   "tabWidth": 2,
   "semi": true,

apps/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ontime-ui",
-  "version": "2.9.0",
+  "version": "2.16.2",
   "private": true,
   "dependencies": {
     "@chakra-ui/react": "^2.7.0",
@@ -39,7 +39,7 @@
     "build": "vite build",
     "build:local": "cross-env NODE_ENV=local vite build",
     "build:docker": "vite build",
-    "lint": "eslint .",
+    "lint": "eslint . --quiet",
     "test": "vitest",
     "test:pipeline": "vitest run",
     "cleanup": "rm -rf .turbo && rm -rf node_modules && rm -rf build"
@@ -63,17 +63,16 @@
     "@testing-library/react": "^13.1.1",
     "@testing-library/user-event": "^14.1.1",
     "@types/color": "^3.0.3",
-    "@types/luxon": "^3.2.0",
     "@types/react": "^18.0.26",
     "@types/react-dom": "^18.0.10",
     "@types/testing-library__jest-dom": "^5.14.5",
-    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^5.48.1",
+    "@typescript-eslint/parser": "^6.10.0",
     "@vitejs/plugin-react": "^3.0.1",
-    "eslint": "^8.31.0",
+    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jest": "^27.1.7",
+    "eslint-plugin-jest": "^27.6.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-react": "^7.32.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-simple-import-sort": "^8.0.0",
@@ -81,9 +80,9 @@
     "jsdom": "^21.1.0",
     "ontime-types": "workspace:*",
     "ontime-utils": "workspace:*",
-    "prettier": "^2.8.3",
+    "prettier": "^3.0.3",
     "sass": "^1.57.1",
-    "typescript": "^4.9.4",
+    "typescript": "^5.2.2",
     "vite": "^4.3.1",
     "vite-plugin-compression2": "^0.9.0",
     "vite-plugin-svgr": "^2.4.0",

apps/client/src/common/api/apiUtils.ts

@@ -2,18 +2,32 @@ import axios, { AxiosError } from 'axios';
 import { LogLevel } from 'ontime-types';
 import { generateId, millisToString } from 'ontime-utils';
 
+import { ontimeQueryClient } from '../queryClient';
 import { addLog } from '../stores/logger';
 import { nowInMillis } from '../utils/time';
 
-export function logAxiosError(prepend: string, error: unknown) {
+export function maybeAxiosError(error: unknown) {
-  let message;
   if (axios.isAxiosError(error)) {
     const statusText = (error as AxiosError).response?.statusText ?? '';
-    const data = (error as AxiosError).response?.data ?? '';
+    let data = (error as AxiosError).response?.data ?? '';
-    message = `${prepend} ${statusText}: ${data}`;
+    if (typeof data === 'object') {
+      if ('message' in data) {
+        data = JSON.stringify(data.message);
+      } else {
+        data = JSON.stringify(data);
+      }
+    }
+    return `${statusText}: ${data}`;
   } else {
-    message = `${prepend}: ${error}`;
+    if (typeof error !== 'string') {
+      return JSON.stringify(error);
+    }
+    return error;
   }
+}
+
+export function logAxiosError(prepend: string, error: unknown) {
+  const message = `${prepend}: ${maybeAxiosError(error)}`;
 
   addLog({
     id: generateId(),
@@ -23,3 +37,17 @@ export function logAxiosError(prepend: string, error: unknown) {
     text: message,
   });
 }
+
+/**
+ * Utility function invalidates react-query caches
+ */
+export async function invalidateAllCaches() {
+  await ontimeQueryClient.invalidateQueries(['project']);
+  await ontimeQueryClient.invalidateQueries(['aliases']);
+  await ontimeQueryClient.invalidateQueries(['userFields']);
+  await ontimeQueryClient.invalidateQueries(['rundown']);
+  await ontimeQueryClient.invalidateQueries(['appinfo']);
+  await ontimeQueryClient.invalidateQueries(['oscSettings']);
+  await ontimeQueryClient.invalidateQueries(['appSettings']);
+  await ontimeQueryClient.invalidateQueries(['viewSettings']);
+}

apps/client/src/common/api/ontimeApi.ts

@@ -1,8 +1,20 @@
-import axios from 'axios';
+import axios, { AxiosResponse } from 'axios';
-import { Alias, OSCSettings, OscSubscription, ProjectData, Settings, UserFields, ViewSettings } from 'ontime-types';
+import {
+  Alias,
+  DatabaseModel,
+  GetInfo,
+  OntimeRundown,
+  OSCSettings,
+  OscSubscription,
+  ProjectData,
+  Settings,
+  UserFields,
+  ViewSettings,
+} from 'ontime-types';
+import { ExcelImportMap } from 'ontime-utils';
 
 import { apiRepoLatest } from '../../externals';
-import { InfoType } from '../models/Info';
+import fileDownload from '../utils/fileDownload';
 
 import { ontimeURL } from './apiConstants';
 
@@ -27,7 +39,7 @@ export async function postSettings(data: Settings) {
  * @description HTTP request to retrieve application info
  * @return {Promise}
  */
-export async function getInfo(): Promise<InfoType> {
+export async function getInfo(): Promise<GetInfo> {
   const res = await axios.get(`${ontimeURL}/info`);
   return res.data;
 }
@@ -109,45 +121,38 @@ export async function postOscSubscriptions(data: OscSubscription) {
 }
 
 /**
- * @description HTTP request to download db
+ * @description HTTP request to download db in CSV format
- * @return {Promise}
  */
-export const downloadRundown = async () => {
+export const downloadCSV = () => {
-  await axios({
+  return fileDownload(ontimeURL, { name: 'rundown', type: 'csv' }, { type: 'text/csv;charset=utf-8;' });
-    url: `${ontimeURL}/db`,
+};
-    method: 'GET',
-    responseType: 'blob', // important
-  }).then((response) => {
-    const headerLine = response.headers['Content-Disposition'];
-    let filename = 'rundown.json';
 
-    // try and get the filename from the response
+/**
-    if (headerLine != null) {
+ * @description HTTP request to download db in JSON format
-      const startFileNameIndex = headerLine.indexOf('"') + 1;
+ */
-      const endFileNameIndex = headerLine.lastIndexOf('"');
+export const downloadRundown = () => {
-      filename = headerLine.substring(startFileNameIndex, endFileNameIndex);
+  return fileDownload(ontimeURL, { name: 'rundown', type: 'json' }, { type: 'application/json;charset=utf-8;' });
-    }
+};
 
-    const url = window.URL.createObjectURL(new Blob([response.data], { type: 'application/json' }));
+// TODO: should this be extracted to shared code?
-    const link = document.createElement('a');
+export type ProjectFileImportOptions = {
-    link.href = url;
+  onlyRundown: boolean;
-    link.setAttribute('download', filename);
-    document.body.appendChild(link);
-    link.click();
-  });
 };
 
 /**
  * @description HTTP request to upload events db
  * @return {Promise}
  */
-type UploadDataOptions = {
+export const uploadProjectFile = async (
-  onlyRundown?: boolean;
+  file: File,
-};
+  setProgress: (value: number) => void,
-export const uploadData = async (file: File, setProgress: (value: number) => void, options?: UploadDataOptions) => {
+  options?: Partial<ProjectFileImportOptions>,
+) => {
   const formData = new FormData();
   formData.append('userFile', file);
-  const onlyRundown = options?.onlyRundown || 'false';
+
+  const onlyRundown = Boolean(options?.onlyRundown);
+
   await axios
     .post(`${ontimeURL}/db?onlyRundown=${onlyRundown}`, formData, {
       headers: {
@@ -161,6 +166,47 @@ export const uploadData = async (file: File, setProgress: (value: number) => voi
     .then((response) => response.data.id);
 };
 
+/**
+ * @description Make patch changes to the objects in the db
+ * @return {Promise}
+ */
+export async function patchData(patchDb: Partial<DatabaseModel>) {
+  const response = await axios.patch(`${ontimeURL}/db`, patchDb);
+  return response;
+}
+
+type PostPreviewExcelResponse = {
+  rundown: OntimeRundown;
+  project: ProjectData;
+  userFields: UserFields;
+};
+
+/**
+ * @description Make patch changes to the objects in the db
+ * @return {Promise} - returns parsed rundown and userfields
+ */
+export async function postPreviewExcel(file: File, setProgress: (value: number) => void, options?: ExcelImportMap) {
+  const formData = new FormData();
+  formData.append('userFile', file);
+  formData.append('options', JSON.stringify(options));
+
+  const response: AxiosResponse<PostPreviewExcelResponse> = await axios.post(
+    `${ontimeURL}/preview-spreadsheet`,
+    formData,
+    {
+      headers: {
+        'Content-Type': 'multipart/form-data',
+      },
+      onUploadProgress: (progressEvent) => {
+        const complete = progressEvent?.total ? Math.round((progressEvent.loaded * 100) / progressEvent.total) : 0;
+        setProgress(complete);
+      },
+    },
+  );
+
+  return response;
+}
+
 export type HasUpdate = {
   url: string;
   version: string;

apps/client/src/common/components/input/colour-input/SwatchSelect.tsx

@@ -1,6 +1,6 @@
 import { useCallback } from 'react';
 
-import { TitleActions } from '../../../../features/event-editor/composite/EventEditorDataLeft';
+import { EditorUpdateFields } from '../../../../features/event-editor/EventEditor';
 
 import Swatch from './Swatch';
 
@@ -8,8 +8,8 @@ import style from './SwatchSelect.module.scss';
 
 interface ColourInputProps {
   value: string;
-  name: TitleActions;
+  name: EditorUpdateFields;
-  handleChange: (newValue: TitleActions, name: string) => void;
+  handleChange: (newValue: EditorUpdateFields, name: string) => void;
 }
 
 const colours = [

apps/client/src/common/components/multi-part-progress-bar/MultiPartProgressBar.tsx

@@ -25,8 +25,14 @@ export default function MultiPartProgressBar(props: MultiPartProgressBar) {
   return (
     <div className={`multiprogress-bar ${hidden ? 'multiprogress-bar--hidden' : ''} ${className}`}>
       <div className='multiprogress-bar__bg-normal' style={{ backgroundColor: normalColor }} />
-      <div className='multiprogress-bar__bg-warning' style={{ width: `${warningWidth}%`, backgroundColor: warningColor }} />
+      <div
-      <div className='multiprogress-bar__bg-danger' style={{ width: `${dangerWidth}%`, backgroundColor: dangerColor }} />
+        className='multiprogress-bar__bg-warning'
+        style={{ width: `${warningWidth}%`, backgroundColor: warningColor }}
+      />
+      <div
+        className='multiprogress-bar__bg-danger'
+        style={{ width: `${dangerWidth}%`, backgroundColor: dangerColor }}
+      />
       <div className='multiprogress-bar__indicator' style={{ width: `${percentComplete}%` }} />
     </div>
   );

apps/client/src/common/components/schedule/Schedule.tsx

@@ -1,5 +1,3 @@
-import Empty from '../state/Empty';
-
 import { useSchedule } from './ScheduleContext';
 import ScheduleItem from './ScheduleItem';
 
@@ -13,8 +11,9 @@ interface ScheduleProps {
 export default function Schedule({ isProduction, className }: ScheduleProps) {
   const { paginatedEvents, selectedEventId, isBackstage, scheduleType } = useSchedule();
 
+  // TODO: design a nice placeholder for empty schedules
   if (paginatedEvents?.length < 1) {
-    return <Empty text='No events to show' />;
+    return null;
   }
 
   let selectedState: 'past' | 'now' | 'future' = 'past';

apps/client/src/common/components/schedule/ScheduleContext.tsx

@@ -1,7 +1,9 @@
 import { createContext, PropsWithChildren, useContext, useState } from 'react';
+import { useSearchParams } from 'react-router-dom';
 import { OntimeEvent } from 'ontime-types';
 
 import { useInterval } from '../../hooks/useInterval';
+import { isStringBoolean } from '../../utils/viewUtils';
 
 interface ScheduleContextState {
   events: OntimeEvent[];
@@ -19,7 +21,6 @@ interface ScheduleProviderProps {
   events: OntimeEvent[];
   selectedEventId: string | null;
   isBackstage?: boolean;
-  eventsPerPage?: number;
   time?: number;
 }
 
@@ -28,16 +29,29 @@ export const ScheduleProvider = ({
   events,
   selectedEventId,
   isBackstage = false,
-  eventsPerPage = 7,
   time = 10,
 }: PropsWithChildren<ScheduleProviderProps>) => {
   const [visiblePage, setVisiblePage] = useState(0);
+  const [searchParams] = useSearchParams();
 
-  const numPages = Math.ceil(events.length / eventsPerPage);
+  // look for overrides from views
+  const hidePast = isStringBoolean(searchParams.get('hidePast'));
+  const stopCycle = isStringBoolean(searchParams.get('stopCycle'));
+  const eventsPerPage = Number(searchParams.get('eventsPerPage') ?? 7);
+
+  let selectedEventIndex = events.findIndex((event) => event.id === selectedEventId);
+
+  const viewEvents = [...events];
+  if (hidePast) {
+    // we want to show the event after the next
+    viewEvents.splice(0, selectedEventIndex + 2);
+    selectedEventIndex = 0;
+  }
+
+  const numPages = Math.ceil(viewEvents.length / eventsPerPage);
   const eventStart = eventsPerPage * visiblePage;
   const eventEnd = eventsPerPage * (visiblePage + 1);
-  const paginatedEvents = events.slice(eventStart, eventEnd);
+  const paginatedEvents = viewEvents.slice(eventStart, eventEnd);
-  const selectedEventIndex = events.findIndex((event) => event.id === selectedEventId);
 
   const resolveScheduleType = () => {
     if (selectedEventIndex >= eventStart && selectedEventIndex < eventEnd) {
@@ -52,7 +66,9 @@ export const ScheduleProvider = ({
 
   // every SCROLL_TIME go to the next array
   useInterval(() => {
-    if (events.length > eventsPerPage) {
+    if (stopCycle) {
+      setVisiblePage(0);
+    } else if (events.length > eventsPerPage) {
       const next = (visiblePage + 1) % numPages;
       setVisiblePage(next);
     }

apps/client/src/common/components/schedule/ScheduleItem.tsx

@@ -14,16 +14,7 @@ interface ScheduleItemProps {
 }
 
 export default function ScheduleItem(props: ScheduleItemProps) {
-  const {
+  const { selected, timeStart, timeEnd, title, presenter, backstageEvent, colour, skip } = props;
-    selected,
-    timeStart,
-    timeEnd,
-    title,
-    presenter,
-    backstageEvent,
-    colour,
-    skip,
-  } = props;
 
   const start = formatTime(timeStart, { format: 'hh:mm' });
   const end = formatTime(timeEnd, { format: 'hh:mm' });
@@ -37,9 +28,7 @@ export default function ScheduleItem(props: ScheduleItemProps) {
         {`${start} → ${end} ${backstageEvent ? '*' : ''}`}
       </div>
       <div className='entry-title'>{title}</div>
-      {presenter && (
+      {presenter && <div className='entry-presenter'>{presenter}</div>}
-        <div className='entry-presenter'>{presenter}</div>
-      )}
     </li>
   );
 }

apps/client/src/common/components/schedule/ScheduleNav.tsx

@@ -13,12 +13,11 @@ export default function ScheduleNav({ className }: ScheduleNavProps) {
     <div className={`schedule-nav ${className}`}>
       {numPages > 1 &&
         [...Array(numPages).keys()].map((i) => (
-            <div
+          <div
-              key={i}
+            key={i}
-              className={i === visiblePage ? 'schedule-nav__item schedule-nav__item--selected' : 'schedule-nav__item'}
+            className={i === visiblePage ? 'schedule-nav__item schedule-nav__item--selected' : 'schedule-nav__item'}
-            />
+          />
-          ),
+        ))}
-        )}
     </div>
   );
 }

apps/client/src/common/components/view-params-editor/ViewParamsEditor.tsx

@@ -1,5 +1,5 @@
 import { FormEvent, useEffect } from 'react';
-import { useSearchParams } from 'react-router-dom';
+import { useLocation, useSearchParams } from 'react-router-dom';
 import {
   Button,
   Drawer,
@@ -12,11 +12,27 @@ import {
   useDisclosure,
 } from '@chakra-ui/react';
 
+import { useLocalStorage } from '../../../common/hooks/useLocalStorage';
+
 import ParamInput from './ParamInput';
 import { ParamField } from './types';
 
 import style from './ViewParamsEditor.module.scss';
 
+type ViewParamsObj = { [key: string]: string | FormDataEntryValue };
+type SavedViewParams = Record<string, ViewParamsObj>;
+
+const getURLSearchParamsFromObj = (paramsObj: ViewParamsObj) =>
+  Object.entries(paramsObj).reduce((newSearchParams, [id, value]) => {
+    if (typeof value === 'string' && value.length) {
+      newSearchParams.set(id, value);
+
+      return newSearchParams;
+    }
+
+    return newSearchParams;
+  }, new URLSearchParams());
+
 interface EditFormDrawerProps {
   paramFields: ParamField[];
 }
@@ -24,6 +40,8 @@ interface EditFormDrawerProps {
 export default function ViewParamsEditor({ paramFields }: EditFormDrawerProps) {
   const [searchParams, setSearchParams] = useSearchParams();
   const { isOpen, onClose, onOpen } = useDisclosure();
+  const { pathname } = useLocation();
+  const [storedViewParams, setStoredViewParams] = useLocalStorage<SavedViewParams>('ontime-views', {});
 
   useEffect(() => {
     const isEditing = searchParams.get('edit');
@@ -33,6 +51,19 @@ export default function ViewParamsEditor({ paramFields }: EditFormDrawerProps) {
     }
   }, [searchParams, onOpen]);
 
+  useEffect(() => {
+    const viewParamsObjFromLocalStorage = storedViewParams[pathname];
+
+    if (viewParamsObjFromLocalStorage !== undefined) {
+      const defaultSearchParams = getURLSearchParamsFromObj(viewParamsObjFromLocalStorage);
+      setSearchParams(defaultSearchParams);
+    }
+
+    // linter is asking for `setSearchParams` in the useEffect deps
+    // rule is disabled since adding `setSearchParams` results in unnecessary re-renders
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [storedViewParams, pathname]);
+
   const onEditDrawerClose = () => {
     onClose();
 
@@ -41,6 +72,7 @@ export default function ViewParamsEditor({ paramFields }: EditFormDrawerProps) {
   };
 
   const clearParams = () => {
+    setStoredViewParams({ ...storedViewParams, [pathname]: {} });
     setSearchParams();
     onClose();
   };
@@ -49,15 +81,9 @@ export default function ViewParamsEditor({ paramFields }: EditFormDrawerProps) {
     formEvent.preventDefault();
 
     const newParamsObject = Object.fromEntries(new FormData(formEvent.currentTarget));
-    const newSearchParams = Object.entries(newParamsObject).reduce((newSearchParams, [id, value]) => {
+    const newSearchParams = getURLSearchParamsFromObj(newParamsObject);
-      if (typeof value === 'string' && value.length) {
-        newSearchParams.set(id, value);
 
-        return newSearchParams;
+    setStoredViewParams({ ...storedViewParams, [pathname]: newParamsObject });
-      }
-
-      return newSearchParams;
-    }, new URLSearchParams());
     setSearchParams(newSearchParams);
   };
 

apps/client/src/common/components/view-params-editor/constants.ts

@@ -132,7 +132,7 @@ export const MINIMAL_TIMER_OPTIONS: ParamField[] = [
   {
     id: 'hideovertime',
     title: 'Hide Overtime',
-    description: 'Whether to supress overtime styles (red borders and red text)',
+    description: 'Whether to suppress overtime styles (red borders and red text)',
     type: 'boolean',
   },
   {
@@ -194,6 +194,49 @@ export const LOWER_THIRDS_OPTIONS: ParamField[] = [
   },
 ];
 
+export const BACKSTAGE_OPTIONS: ParamField[] = [
+  TIME_FORMAT_OPTION,
+  {
+    id: 'hidePast',
+    title: 'Hide past events',
+    description: 'Scheduler will only show upcoming events',
+    type: 'boolean',
+  },
+  {
+    id: 'stopCycle',
+    title: 'Stop cycling through event pages',
+    description: 'Schedule will not auto-cycle through events',
+    type: 'boolean',
+  },
+  {
+    id: 'eventsPerPage',
+    title: 'Events per page',
+    description: 'Sets the number of events on the page, can cause overlow',
+    type: 'number',
+  },
+];
+
+export const PUBLIC_OPTIONS: ParamField[] = [
+  TIME_FORMAT_OPTION,
+  {
+    id: 'hidePast',
+    title: 'Hide past events',
+    description: 'Scheduler will only show upcoming events',
+    type: 'boolean',
+  },
+  {
+    id: 'stopCycle',
+    title: 'Stop cycling through event pages',
+    description: 'Schedule will not auto-cycle through events',
+    type: 'boolean',
+  },
+  {
+    id: 'eventsPerPage',
+    title: 'Events per page',
+    description: 'Sets the number of events on the page, can cause overlow',
+    type: 'number',
+  },
+];
 export const STUDIO_CLOCK_OPTIONS: ParamField[] = [
   TIME_FORMAT_OPTION,
   {

apps/client/src/common/hooks-query/useInfo.ts

@@ -1,4 +1,5 @@
 import { useQuery } from '@tanstack/react-query';
+import { GetInfo } from 'ontime-types';
 
 import { queryRefetchIntervalSlow } from '../../ontimeConfig';
 import { APP_INFO } from '../api/apiConstants';
@@ -6,7 +7,7 @@ import { getInfo } from '../api/ontimeApi';
 import { ontimePlaceholderInfo } from '../models/Info';
 
 export default function useInfo() {
-  const { data, status, isError, refetch } = useQuery({
+  const { data, status, isError, refetch, isFetching } = useQuery<GetInfo>({
     queryKey: APP_INFO,
     queryFn: getInfo,
     placeholderData: ontimePlaceholderInfo,
@@ -16,5 +17,5 @@ export default function useInfo() {
     networkMode: 'always',
   });
 
-  return { data, status, isError, refetch };
+  return { data, status, isError, refetch, isFetching };
 }

apps/client/src/common/hooks/useClickOutside.ts

@@ -6,7 +6,6 @@ export default function useClickOutside<T extends HTMLElement = HTMLElement>(
   ref: RefObject<T>,
   callback: ClickOutsideEventHandler,
 ) {
-
   useEffect(() => {
     function handleClick(event: MouseEvent) {
       const element = ref?.current;

apps/client/src/common/hooks/useElectronEvent.ts

@@ -1,7 +1,7 @@
 export default function useElectronEvent() {
   const isElectron = window?.process?.type === 'renderer';
 
-  const sendToElectron = (channel: string, args?: string | Record<string, any>) => {
+  const sendToElectron = (channel: string, args?: string | Record<string, unknown>) => {
     if (isElectron) {
       window?.ipcRenderer.send(channel, args);
     }

apps/client/src/common/hooks/useEventAction.ts

@@ -100,7 +100,7 @@ export const useEventAction = () => {
         // @ts-expect-error -- we know that the object is well formed now
         await _addEventMutation.mutateAsync(newEvent);
       } catch (error) {
-        logAxiosError('Error fetching data', error);
+        logAxiosError('Failed adding event', error);
       }
     },
     [_addEventMutation, defaultPublic, queryClient, startTimeIsLastEnd],

apps/client/src/common/hooks/useFitText.ts

@@ -1,10 +1,4 @@
-import {
+import { useCallback, useEffect, useLayoutEffect, useRef, useState } from 'react';
-  useCallback,
-  useEffect,
-  useLayoutEffect,
-  useRef,
-  useState,
-} from 'react';
 
 export type TLogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
 
@@ -26,13 +20,13 @@ const LOG_LEVEL: Record<TLogLevel, number> = {
 };
 
 const useFitText = ({
-                      logLevel: logLevelOption = 'info',
+  logLevel: logLevelOption = 'info',
-                      maxFontSize = 100,
+  maxFontSize = 100,
-                      minFontSize = 20,
+  minFontSize = 20,
-                      onFinish,
+  onFinish,
-                      onStart,
+  onStart,
-                      resolution = 5,
+  resolution = 5,
-                    }: TOptions = {}) => {
+}: TOptions = {}) => {
   const logLevel = LOG_LEVEL[logLevelOption];
 
   const initState = useCallback(() => {
@@ -112,8 +106,7 @@ const useFitText = ({
     const isWithinResolution = Math.abs(fontSize - fontSizePrev) <= resolution;
     const isOverflow =
       !!ref.current &&
-      (ref.current.scrollHeight > ref.current.offsetHeight ||
+      (ref.current.scrollHeight > ref.current.offsetHeight || ref.current.scrollWidth > ref.current.offsetWidth);
-        ref.current.scrollWidth > ref.current.offsetWidth);
     const isFailed = isOverflow && fontSize === fontSizePrev;
     const isAsc = fontSize > fontSizePrev;
 
@@ -123,9 +116,7 @@ const useFitText = ({
       if (isFailed) {
         isCalculatingRef.current = false;
         if (logLevel <= LOG_LEVEL.info) {
-          console.info(
+          console.info(`[use-fit-text] reached \`minFontSize = ${minFontSize}\` without fitting text`);
-            `[use-fit-text] reached \`minFontSize = ${minFontSize}\` without fitting text`,
-          );
         }
       } else if (isOverflow) {
         setState({
@@ -160,16 +151,7 @@ const useFitText = ({
       fontSizeMin: newMin,
       fontSizePrev: fontSize,
     });
-  }, [
+  }, [calcKey, fontSize, fontSizeMax, fontSizeMin, fontSizePrev, onFinish, ref, resolution]);
-    calcKey,
-    fontSize,
-    fontSizeMax,
-    fontSizeMin,
-    fontSizePrev,
-    onFinish,
-    ref,
-    resolution,
-  ]);
 
   return { fontSize: `${fontSize}%`, ref };
 };

apps/client/src/common/hooks/useInterval.js

@@ -1,4 +1,4 @@
-import { useEffect, useRef } from "react";
+import { useEffect, useRef } from 'react';
 
 /**
  * @description utility hook to around setInterval

apps/client/src/common/hooks/useLocalStorage.ts

@@ -46,7 +46,7 @@ export const useLocalStorage = <T>(key: string, initialValue: T): [T, (value: T
       setStoredValue(valueToStore);
       window.localStorage.setItem(`ontime-${key}`, JSON.stringify(valueToStore));
     } catch (error) {
-      console.log(error);
+      console.error(error);
     }
   };
   return [storedValue, setValue];

apps/client/src/common/models/Info.ts

@@ -1,19 +1,25 @@
-import { Settings } from 'ontime-types';
+import { GetInfo, OSCSettings } from 'ontime-types';
 
-type NetworkInterfaceType = {
+export const oscPlaceholderSettings: OSCSettings = {
-  name: string;
+  portIn: 0,
-  address: string;
+  portOut: 0,
-};
+  targetIP: '',
-
+  enabledIn: false,
-export type InfoType = {
+  enabledOut: false,
-  networkInterfaces: NetworkInterfaceType[];
+  subscriptions: {
-  settings: Pick<Settings, 'version' | 'serverPort'>;
+    onLoad: [],
-};
+    onStart: [],
-
+    onPause: [],
-export const ontimePlaceholderInfo: InfoType = {
+    onStop: [],
-  networkInterfaces: [],
+    onUpdate: [],
-  settings: {
+    onFinish: [],
-    version: 2,
-    serverPort: 4001,
   },
 };
+
+export const ontimePlaceholderInfo: GetInfo = {
+  networkInterfaces: [],
+  version: '2.0.0',
+  serverPort: 4001,
+  osc: oscPlaceholderSettings,
+  cssOverride: '',
+};

apps/client/src/common/models/OntimeSettings.ts

@@ -2,7 +2,7 @@ import { Settings } from 'ontime-types';
 
 export const ontimePlaceholderSettings: Settings = {
   app: 'ontime',
-  version: 2,
+  version: '2.0.0',
   serverPort: 4001,
   editorKey: null,
   operatorKey: null,

apps/client/src/common/utils/__tests__/aliases.test.js

@@ -1,5 +1,6 @@
 import { resolvePath } from 'react-router-dom';
-import { validateAlias, generateURLFromAlias, getAliasRoute } from '../aliases';
+
+import { generateURLFromAlias, getAliasRoute, validateAlias } from '../aliases';
 
 describe('An alias fails if incorrect', () => {
   const testsToFail = [

apps/client/src/common/utils/__tests__/math.test.js

@@ -12,7 +12,7 @@ test('Clamps a set of numbers correctly', () => {
     { num: -50, min: 0, max: 0, result: 0 },
     { num: 50.5, min: 0, max: 100, result: 50.5 },
     { num: 50, min: 0, max: 20.32, result: 20.32 },
-    { num: 10, min: 20.32, max: 40, result: 20.32 }
+    { num: 10, min: 20.32, max: 40, result: 20.32 },
   ];
 
   testCases.forEach((t) => expect(clamp(t.num, t.min, t.max)).toBe(t.result));

apps/client/src/common/utils/aliases.ts

@@ -47,7 +47,7 @@ export const getAliasRoute = (location: Location, data: Alias[], searchParams: U
   const aliasOnPage = searchParams.get('alias');
   for (const d of data) {
     if (aliasOnPage) {
-      // if the alias fits the alias on this page, but the URL is diferent, we redirect user to the new URL
+      // if the alias fits the alias on this page, but the URL is different, we redirect user to the new URL
       // if we have the same alias and its enabled and its not empty
       if (d.alias !== '' && d.enabled && d.alias === aliasOnPage) {
         const newAliasPath = resolvePath(d.pathAndParams);

apps/client/src/common/utils/fileDownload.ts

@@ -0,0 +1,56 @@
+import axios from 'axios';
+
+import { makeCSV, makeTable } from '../../features/cuesheet/cuesheetUtils';
+
+type FileOptions = {
+  name: string;
+  type: string;
+};
+
+type BlobOptions = {
+  type: string;
+};
+
+export default async function fileDownload(url: string, fileOptions: FileOptions, blobOptions: BlobOptions) {
+  const response = await axios({
+    url: `${url}/db`,
+    method: 'GET',
+  });
+
+  const headerLine = response.headers['Content-Disposition'];
+  let { name: fileName } = fileOptions;
+  const { type: fileType } = fileOptions;
+  const { project, rundown, userFields } = response.data;
+
+  // try and get the filename from the response
+  if (headerLine != null) {
+    const startFileNameIndex = headerLine.indexOf('"') + 1;
+    const endFileNameIndex = headerLine.lastIndexOf('"');
+    fileName = headerLine.substring(startFileNameIndex, endFileNameIndex);
+  }
+
+  let fileContent = '';
+
+  if (fileType === 'json') {
+    fileContent = JSON.stringify(response.data);
+    fileName += '.json';
+  }
+
+  if (fileType === 'csv') {
+    const sheetData = makeTable(project, rundown, userFields);
+    fileContent = makeCSV(sheetData);
+    fileName += '.csv';
+  }
+
+  const blob = new Blob([fileContent], { type: blobOptions.type });
+  const downloadUrl = URL.createObjectURL(blob);
+
+  const link = document.createElement('a');
+  link.setAttribute('href', downloadUrl);
+  link.setAttribute('download', fileName);
+  document.body.appendChild(link);
+  link.click();
+  // Clean up the URL.createObjectURL to release resources
+  URL.revokeObjectURL(downloadUrl);
+  return;
+}

apps/client/src/common/utils/socket.ts

@@ -129,7 +129,7 @@ export const socketSend = (message: any) => {
   }
 };
 
-export const socketSendJson = (type: string, payload?: any) => {
+export const socketSendJson = (type: string, payload?: unknown) => {
   socketSend(
     JSON.stringify({
       type,

apps/client/src/common/utils/styleUtils.ts

@@ -10,13 +10,13 @@ type ColourCombination = {
  * @param bgColour
  * @return {{backgroundColor, color: string}}
  */
-export const getAccessibleColour = (bgColour: string): ColourCombination => {
+export const getAccessibleColour = (bgColour?: string): ColourCombination => {
   if (bgColour) {
     try {
       const textColor = Color(bgColour).isLight() ? 'black' : '#fffffa';
       return { backgroundColor: bgColour, color: textColor };
-    } catch (error) {
+    } catch (_error) {
-      console.log(`Unable to parse colour: ${bgColour}`);
+      /* we do not handle errors here */
     }
   }
   return { backgroundColor: '#000', color: '#fffffa' };

apps/client/src/declarations/declaration.d.ts

@@ -13,9 +13,8 @@ declare global {
     };
     process: {
       type: string;
-    }
+    };
   }
 }
 
-// eslint-disable-next-line import/no-anonymous-default-export
+export default {};
-export default {}

apps/client/src/declarations/test.d.ts

@@ -6,6 +6,6 @@ import 'vitest';
 // https://github.com/testing-library/jest-dom/issues/123
 declare global {
   namespace Vi {
-    interface Assertion<T = any> extends TestingLibraryMatchers<T, void> {}
+    type Assertion<T = any> = TestingLibraryMatchers<T, void>;
   }
 }

apps/client/src/features/AliasWrapper.tsx

@@ -22,7 +22,7 @@ const withAlias = <P extends object>(Component: ComponentType<P>) => {
       }
     }, [data, searchParams, navigate, location]);
 
-    return <Component {...props} />;
+    return <Component {...(props as P)} />;
   };
 };
 

apps/client/src/features/control/message/MessageControl.tsx

@@ -42,7 +42,7 @@ export default function MessageControl() {
         actionHandler={() => setMessage.presenterVisible(!data.timerMessage.visible)}
       />
       <div className={style.buttonSection}>
-        <label className={style.label}>Timer messsage blink</label>
+        <label className={style.label}>Timer message blink</label>
         <label className={style.label}>Blackout timer screens</label>
         <Button
           className={`${data.timerMessage.timerBlink ? style.blink : ''}`}

apps/client/src/features/cuesheet/Cuesheet.module.scss

@@ -44,6 +44,11 @@ $table-header-font-size: calc(1rem - 3px);
     min-width: 2rem;
     text-align: right;
     font-weight: 400;
+
+    position: sticky;
+    left: 0;
+    z-index: 1;
+    background-color: $gray-1300;
   }
 }
 

apps/client/src/features/cuesheet/Cuesheet.tsx

@@ -1,5 +1,6 @@
 import { useRef } from 'react';
 import { ColumnDef, flexRender, getCoreRowModel, useReactTable } from '@tanstack/react-table';
+import Color from 'color';
 import { isOntimeBlock, isOntimeDelay, isOntimeEvent, OntimeRundown, OntimeRundownEntry } from 'ontime-types';
 
 import useFollowComponent from '../../common/hooks/useFollowComponent';
@@ -117,6 +118,14 @@ export default function Cuesheet({ data, columns, handleUpdate, selectedId }: Cu
                 let rowBgColour: string | undefined;
                 if (isSelected) {
                   rowBgColour = 'var(--cuesheet-running-bg-override, #D20300)'; // $red-700
+                } else if (row.original.colour) {
+                  try {
+                    // the colour is user defined and might be invalid
+                    const colour = new Color(row.original.colour).alpha(0.25);
+                    rowBgColour = colour.hsl().string();
+                  } catch (_error) {
+                    /* we do not handle errors here */
+                  }
                 }
 
                 return (

apps/client/src/features/cuesheet/CuesheetWrapper.tsx

@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useMemo } from 'react';
+import { useCallback, useEffect, useMemo, useState } from 'react';
 import { OntimeRundownEntry, ProjectData } from 'ontime-types';
 
 import Empty from '../../common/components/state/Empty';
@@ -6,6 +6,7 @@ import { useEventAction } from '../../common/hooks/useEventAction';
 import { useCuesheet } from '../../common/hooks/useSocket';
 import useRundown from '../../common/hooks-query/useRundown';
 import useUserFields from '../../common/hooks-query/useUserFields';
+import ExportModal, { ExportType } from '../modals/export-modal/ExportModal';
 
 import CuesheetTableHeader from './cuesheet-table-header/CuesheetTableHeader';
 import Cuesheet from './Cuesheet';
@@ -20,6 +21,8 @@ export default function CuesheetWrapper() {
   const { updateEvent } = useEventAction();
   const featureData = useCuesheet();
   const columns = useMemo(() => makeCuesheetColumns(userFields), [userFields]);
+  const [isModalOpen, setIsModalOpen] = useState(false);
+  const [headerData, setheaderData] = useState<ProjectData | null>(null);
 
   // Set window title
   useEffect(() => {
@@ -69,37 +72,76 @@ export default function CuesheetWrapper() {
   );
 
   const exportHandler = useCallback(
-    (headerData: ProjectData) => {
+    (headerData: ProjectData, exportType: ExportType) => {
       if (!headerData || !rundown || !userFields) {
         return;
       }
 
-      const sheetData = makeTable(headerData, rundown, userFields);
+      let fileName = '';
-      const csvContent = makeCSV(sheetData);
+      let url = '';
 
-      const blob = new Blob([csvContent], { type: 'text/csv;charset=utf-8;' });
+      if (exportType === 'json') {
-      const url = URL.createObjectURL(blob);
+        const jsonContent = JSON.stringify({
+          headerData,
+          rundown,
+          userFields,
+        });
+
+        fileName = 'ontime export.json';
+
+        const blob = new Blob([jsonContent], { type: 'application/json;charset=utf-8;' });
+        url = URL.createObjectURL(blob);
+      } else if (exportType === 'csv') {
+        const sheetData = makeTable(headerData, rundown, userFields);
+        const csvContent = makeCSV(sheetData);
+
+        fileName = 'ontime export.csv';
+
+        const blob = new Blob([csvContent], { type: 'text/csv;charset=utf-8;' });
+        url = URL.createObjectURL(blob);
+      } else {
+        console.error('Invalid export type: ', exportType);
+        return;
+      }
 
       const link = document.createElement('a');
       link.setAttribute('href', url);
-      link.setAttribute('download', 'ontime export.csv');
+      link.setAttribute('download', fileName);
       document.body.appendChild(link);
       link.click();
-
       // Clean up the URL.createObjectURL to release resources
       URL.revokeObjectURL(url);
+      return;
     },
     [rundown, userFields],
   );
 
+  const onModalClose = (exportType?: ExportType) => {
+    setIsModalOpen(false);
+
+    if (!exportType) {
+      return;
+    }
+
+    if (headerData) {
+      exportHandler(headerData, exportType);
+    }
+  };
+
+  const handleOpenModal = (projectData: ProjectData) => {
+    setheaderData(projectData);
+    setIsModalOpen(true);
+  };
+
   if (!rundown || !userFields) {
     return <Empty text='Loading...' />;
   }
 
   return (
     <div className={styles.tableWrapper} data-testid='cuesheet'>
-      <CuesheetTableHeader handleCSVExport={exportHandler} featureData={featureData} />
+      <CuesheetTableHeader handleExport={handleOpenModal} featureData={featureData} />
       <Cuesheet data={rundown} columns={columns} handleUpdate={handleUpdate} selectedId={featureData.selectedEventId} />
+      <ExportModal isOpen={isModalOpen} onClose={onModalClose} />
     </div>
   );
 }

apps/client/src/features/cuesheet/cuesheet-table-elements/CuesheetRow.tsx

@@ -1,6 +0,0 @@
-interface CuesheetRowProps {
-  row: OntimeRundownEntry;
-  isSelected: boolean;
-}
-
-function CuesheetRow() {}

apps/client/src/features/cuesheet/cuesheet-table-elements/EventRow.tsx

@@ -19,9 +19,8 @@ function EventRow(props: PropsWithChildren<EventRowProps>) {
   const ownRef = useRef<HTMLTableRowElement>(null);
   const [isVisible, setIsVisible] = useState(false);
 
-  const bgFallback = 'transparent';
+  const bgColour = colour;
-  const bgColour = colour || bgFallback;
+  const textColour = getAccessibleColour(bgColour);
-  const textColour = bgColour === bgFallback ? undefined : getAccessibleColour(bgColour);
 
   useLayoutEffect(() => {
     const observer = new IntersectionObserver(

apps/client/src/features/cuesheet/cuesheet-table-header/CuesheetTableHeader.tsx

@@ -16,7 +16,7 @@ import CuesheetTableHeaderTimers from './CuesheetTableHeaderTimers';
 import style from './CuesheetTableHeader.module.scss';
 
 interface CuesheetTableHeaderProps {
-  handleCSVExport: (headerData: ProjectData) => void;
+  handleExport: (headerData: ProjectData) => void;
   featureData: {
     playback: Playback;
     selectedEventIndex: number | null;
@@ -25,7 +25,7 @@ interface CuesheetTableHeaderProps {
   };
 }
 
-export default function CuesheetTableHeader({ handleCSVExport, featureData }: CuesheetTableHeaderProps) {
+export default function CuesheetTableHeader({ handleExport, featureData }: CuesheetTableHeaderProps) {
   const followSelected = useCuesheetSettings((state) => state.followSelected);
   const showSettings = useCuesheetSettings((state) => state.showSettings);
   const toggleSettings = useCuesheetSettings((state) => state.toggleSettings);
@@ -33,9 +33,9 @@ export default function CuesheetTableHeader({ handleCSVExport, featureData }: Cu
   const { isFullScreen, toggleFullScreen } = useFullscreen();
   const { data: project } = useProjectData();
 
-  const exportCsv = () => {
+  const exportProject = () => {
     if (project) {
-      handleCSVExport(project);
+      handleExport(project);
     }
   };
 
@@ -72,9 +72,9 @@ export default function CuesheetTableHeader({ handleCSVExport, featureData }: Cu
             {isFullScreen ? <IoContract /> : <IoExpand />}
           </span>
         </Tooltip>
-        <Tooltip openDelay={tooltipDelayFast} label='Export rundown to CSV'>
+        <Tooltip openDelay={tooltipDelayFast} label='Export rundown'>
-          <span className={style.actionIcon} onClick={exportCsv}>
+          <span className={style.actionIcon} onClick={exportProject}>
-            CSV
+            Export
           </span>
         </Tooltip>
       </div>

apps/client/src/features/event-editor/composite/CountedTextArea.tsx

@@ -2,16 +2,15 @@ import { useCallback } from 'react';
 import { Textarea } from '@chakra-ui/react';
 
 import useReactiveTextInput from '../../../common/components/input/text-input/useReactiveTextInput';
-
+import { EditorUpdateFields } from '../EventEditor';
-import { TitleActions } from './EventEditorDataLeft';
 
 import style from '../EventEditor.module.scss';
 
 interface CountedTextAreaProps {
-  field: TitleActions;
+  field: EditorUpdateFields;
   label: string;
   initialValue: string;
-  submitHandler: (field: TitleActions, value: string) => void;
+  submitHandler: (field: EditorUpdateFields, value: string) => void;
 }
 
 export default function CountedTextArea(props: CountedTextAreaProps) {

apps/client/src/features/menu/MenuBar.tsx

@@ -1,4 +1,4 @@
-import { memo, useCallback, useEffect } from 'react';
+import { memo, useCallback, useEffect, useState } from 'react';
 import { VStack } from '@chakra-ui/react';
 import { IoColorWand } from '@react-icons/all-files/io5/IoColorWand';
 import { IoExtensionPuzzle } from '@react-icons/all-files/io5/IoExtensionPuzzle';
@@ -10,11 +10,12 @@ import { IoPushOutline } from '@react-icons/all-files/io5/IoPushOutline';
 import { IoSaveOutline } from '@react-icons/all-files/io5/IoSaveOutline';
 import { IoSettingsOutline } from '@react-icons/all-files/io5/IoSettingsOutline';
 
-import { downloadRundown } from '../../common/api/ontimeApi';
+import { downloadCSV, downloadRundown } from '../../common/api/ontimeApi';
 import QuitIconBtn from '../../common/components/buttons/QuitIconBtn';
 import TooltipActionBtn from '../../common/components/buttons/TooltipActionBtn';
 import useElectronEvent from '../../common/hooks/useElectronEvent';
 import { AppMode, useAppMode } from '../../common/stores/appModeStore';
+import ExportModal, { ExportType } from '../modals/export-modal/ExportModal';
 
 import style from './MenuBar.module.scss';
 
@@ -100,6 +101,22 @@ const MenuBar = (props: MenuBarProps) => {
     };
   }, [handleKeyPress, isElectron]);
 
+  const [isModalOpen, setIsModalOpen] = useState(false);
+
+  const onModalClose = (exportType?: ExportType) => {
+    setIsModalOpen(false);
+
+    if (!exportType) {
+      return;
+    }
+
+    if (exportType === 'json') {
+      downloadRundown();
+    } else if (exportType === 'csv') {
+      downloadCSV();
+    }
+  };
+
   return (
     <VStack>
       <QuitIconBtn disabled={!isElectron} clickHandler={sendShutdown} size='md' />
@@ -128,12 +145,14 @@ const MenuBar = (props: MenuBarProps) => {
         {...buttonStyle}
         icon={<IoSaveOutline />}
         isDisabled={appMode === AppMode.Run}
-        clickHandler={downloadRundown}
+        clickHandler={() => setIsModalOpen(true)}
         tooltip='Export project file'
         aria-label='Export project file'
         size='sm'
       />
 
+      <ExportModal onClose={onModalClose} isOpen={isModalOpen} />
+
       <div className={style.gap} />
       <TooltipActionBtn
         {...buttonStyle}

apps/client/src/features/modals/Modal.module.scss

@@ -41,8 +41,8 @@ $el-padding-with-compensation: 24px; // 16 + 8
 .title {
   font-size: $inner-section-text-size;
   color: $gray-500;
-  padding-left: 8px;
+  padding-left: 0.5rem;
-  margin: 8px 0;
+  margin: 0.5rem 0;
   text-transform: uppercase;
 }
 
@@ -107,6 +107,16 @@ $el-padding-with-compensation: 24px; // 16 + 8
   color: $error-red;
 }
 
+.success {
+  @include subsection;
+  color: $action-blue;
+}
+
+.feedbackSection {
+  justify-content: flex-start;
+
+}
+
 .buttonSection {
   margin-top: $section-spacing;
   display: flex;
@@ -117,6 +127,10 @@ $el-padding-with-compensation: 24px; // 16 + 8
   flex-grow: 1;
 }
 
+.vSpacer {
+  height: 2rem;
+}
+
 .shiftRight {
   align-self: flex-end;
 }
@@ -135,6 +149,12 @@ $el-padding-with-compensation: 24px; // 16 + 8
   grid-template-columns: auto 1fr;
 }
 
+.twoEqualColumn {
+  display: grid;
+  grid-template-columns: 1fr 1fr;
+  gap: 1rem;
+}
+
 .padBottom {
   padding-bottom: $element-spacing;
 }

apps/client/src/features/modals/export-modal/ExportModal.module.scss

@@ -0,0 +1,9 @@
+@use '../../../theme/v2Styles' as *;
+
+.buttonRow {
+  justify-content: space-between;
+  margin-top: $section-spacing;
+  display: flex;
+  gap: $section-spacing;
+  margin: 0 0.25rem;
+}

apps/client/src/features/modals/export-modal/ExportModal.tsx

@@ -0,0 +1,32 @@
+import { Button, Modal, ModalBody, ModalCloseButton, ModalContent, ModalHeader, ModalOverlay } from '@chakra-ui/react';
+
+import styles from './ExportModal.module.scss';
+
+export type ExportType = 'csv' | 'json';
+
+interface ExportModalProps {
+  isOpen: boolean;
+  onClose: (type?: ExportType) => void;
+}
+
+export default function ExportModal(props: ExportModalProps) {
+  const { isOpen, onClose } = props;
+
+  return (
+    <Modal isOpen={isOpen} onClose={onClose} motionPreset='slideInBottom' size='xl' variant='ontime-small'>
+      <ModalOverlay />
+      <ModalContent>
+        <ModalHeader className={styles.modalHeader}>Download options</ModalHeader>
+        <ModalCloseButton />
+        <ModalBody className={styles.buttonRow}>
+          <Button onClick={() => onClose('csv')} variant='ontime-subtle-on-light' width='100%'>
+            Rundown as CSV
+          </Button>
+          <Button onClick={() => onClose('json')} variant='ontime-filled' width='100%'>
+            Project file
+          </Button>
+        </ModalBody>
+      </ModalContent>
+    </Modal>
+  );
+}

apps/client/src/features/modals/settings-modal/AliasesForm.tsx

@@ -21,7 +21,9 @@ import style from './SettingsModal.module.scss';
 const aliasesDocsUrl = 'https://ontime.gitbook.io/v2/features/url-aliases';
 
 // we wrap the array in an object to be simplify react-hook-form
-type Aliases = { aliases: Alias[] };
+type Aliases = {
+  aliases: Alias[];
+};
 
 export default function AliasesForm() {
   const { data, status, isFetching, refetch } = useAliases();
@@ -93,8 +95,7 @@ export default function AliasesForm() {
           <AlertDescription>
             Custom aliases allow providing a short name for any ontime URL. <br />
             It serves two primary purposes: <br />
-            - Providing dynamic URLs for automation or unattended screens <br />
+            - Providing dynamic URLs for automation or unattended screens <br />- Simplifying complex URLs
-            - Simplifying complex URLs
             <ModalLink href={aliasesDocsUrl}>For more information, see the docs</ModalLink>
           </AlertDescription>
         </div>

apps/client/src/features/modals/settings-modal/ModalPinInput.tsx

@@ -3,8 +3,12 @@ import { UseFormRegister } from 'react-hook-form';
 import { IconButton, Input, InputGroup, InputRightElement } from '@chakra-ui/react';
 import { IoEyeOutline } from '@react-icons/all-files/io5/IoEyeOutline';
 
+interface FormInput {
+  [key: string]: string;
+}
+
 interface ModalPinInputProps {
-  register: UseFormRegister<any>;
+  register: UseFormRegister<FormInput>;
   formName: string;
   isDisabled?: boolean;
 }

apps/client/src/features/modals/settings-modal/SettingsModal.module.scss

@@ -3,19 +3,24 @@
 .aliases {
   display: flex;
   align-items: center;
-  gap: 8px;
+  gap: 0.5rem;
   flex-direction: column;
   width: 100%;
-  padding: 8px 0;
+  padding: 0.5rem 0;
 
   .aliasRow {
     width: 100%;
     display: flex;
     align-items: center;
-    gap: 8px;
+    gap: 0.5rem;
   }
 
   .grow {
     flex: 1;
   }
 }
+
+.url {
+  font-size: calc(1rem - 2px);
+  user-select: text;
+}

apps/client/src/features/modals/settings-modal/ViewSettingsForm.tsx

@@ -1,16 +1,18 @@
 import { useEffect } from 'react';
 import { useForm } from 'react-hook-form';
-import { Input, Switch } from '@chakra-ui/react';
+import { Alert, AlertDescription, AlertIcon, AlertTitle, Input, Switch } from '@chakra-ui/react';
 import { ViewSettings } from 'ontime-types';
 
 import { logAxiosError } from '../../../common/api/apiUtils';
 import { postViewSettings } from '../../../common/api/ontimeApi';
 import { PopoverPickerRHF } from '../../../common/components/input/popover-picker/PopoverPicker';
+import useInfo from '../../../common/hooks-query/useInfo';
 import useViewSettings from '../../../common/hooks-query/useViewSettings';
 import { mtm } from '../../../common/utils/timeConstants';
 import ModalLoader from '../modal-loader/ModalLoader';
 import { inputProps } from '../modalHelper';
 import ModalInput from '../ModalInput';
+import ModalLink from '../ModalLink';
 import ModalSplitInput from '../ModalSplitInput';
 import OntimeModalFooter from '../OntimeModalFooter';
 
@@ -18,8 +20,12 @@ import InputMillisWithString from './InputMillisWithString';
 
 import style from './SettingsModal.module.scss';
 
+const cssOverrideDocsUrl = 'https://ontime.gitbook.io/v2/features/custom-styling';
+
 export default function ViewSettingsForm() {
   const { data, status, refetch, isFetching } = useViewSettings();
+  const { data: info, isFetching: isFetchingInfo } = useInfo();
+
   const {
     control,
     handleSubmit,
@@ -75,13 +81,24 @@ export default function ViewSettingsForm() {
 
   const disableInputs = status === 'loading';
 
-  if (isFetching) {
+  if (isFetching || isFetchingInfo) {
     return <ModalLoader />;
   }
 
   return (
     <form onSubmit={handleSubmit(onSubmit)} id='view-settings' className={style.sectionContainer}>
       <span className={style.title}>General view settings</span>
+      <Alert status='info' variant='ontime-on-light-info'>
+        <AlertIcon />
+        <div className={style.column}>
+          <AlertTitle>CSS Override</AlertTitle>
+          <AlertDescription>
+            Ontime will use the CSS file at its install location. <br />
+            <span className={style.url}>{info.cssOverride}</span>
+            <ModalLink href={cssOverrideDocsUrl}>For more information, see the docs</ModalLink>
+          </AlertDescription>
+        </div>
+      </Alert>
       <ModalSplitInput
         field='overrideStyles'
         title='Override CSS Styles'

apps/client/src/features/modals/upload-modal/UploadFile.tsx

@@ -0,0 +1,66 @@
+import { ChangeEvent, useRef, useState } from 'react';
+import { Input } from '@chakra-ui/react';
+
+import UploadEntry from './upload-entry/UploadEntry';
+import { useUploadModalContextStore } from './uploadModalContext';
+import { validateFile } from './uploadUtils';
+
+import style from './UploadModal.module.scss';
+
+export default function UploadFile() {
+  const fileInputRef = useRef<HTMLInputElement>(null);
+
+  const { file, setFile, progress } = useUploadModalContextStore();
+
+  const [errors, setErrors] = useState<string>('');
+
+  const clearFile = () => {
+    setFile(null);
+    setErrors('');
+  };
+
+  const handleFile = (event: ChangeEvent<HTMLInputElement>) => {
+    setErrors('');
+
+    const selectedFile = event?.target?.files?.[0];
+    if (!selectedFile) {
+      setFile(null);
+      return;
+    }
+
+    try {
+      validateFile(selectedFile);
+      setFile(selectedFile);
+    } catch (error) {
+      if (error instanceof Error) {
+        setErrors(error.message);
+      } else {
+        setErrors('An unexpected error occurred while validating the file.');
+      }
+      setFile(null);
+    }
+  };
+
+  const handleClick = () => {
+    fileInputRef.current?.click();
+  };
+
+  return (
+    <>
+      <Input
+        ref={fileInputRef}
+        style={{ display: 'none' }}
+        type='file'
+        onChange={handleFile}
+        accept='.json, .xlsx'
+        data-testid='file-input'
+      />
+      {!file && (
+        <div className={style.uploadArea} onClick={handleClick} role='button'>
+          Click to select Ontime project or xlsx rundown
+        </div>
+      )}
+      {(file || errors) && <UploadEntry file={file} errors={errors} progress={progress} handleClear={clearFile} />}
+    </>
+  );
+}

apps/client/src/features/modals/upload-modal/UploadModal.module.scss

@@ -5,79 +5,31 @@
 .uploadBody {
   display: flex;
   flex-direction: column;
-  gap: 16px;
+  gap: 1rem;
 }
 
 .uploadArea {
+  margin: 0 auto;
   width: 100%;
-  min-height: 200px;
+  max-width: 550px;
-  border: 2px dashed $gray-50;
+
+  min-height: 150px;
+  border: 2px dashed $gray-200;
   border-radius: 3px;
   display: grid;
   place-content: center;
   transition-property: background-color;
   transition-duration: $transition-time-action;
+  font-size: calc(1rem - 1px);
 
   &:hover {
     border: 2px solid $blue-500;
     background-color: $blue-50;
     cursor: pointer;
   }
+
   &.comment {
-    color: gray;
+    color: $modal-note-color;
-  }
-}
-
-.uploadedItem {
-  background-color: $gray-50;
-  padding: 8px;
-  display: grid;
-  grid-template-areas:
-          "icon     title     close"
-          "icon     info      ."
-          "progress progress  progress";
-  grid-template-columns: auto 1fr auto;
-  column-gap: 16px;
-  border-radius: 3px;
-
-  .icon {
-    align-self: center;
-    grid-area: icon;
-    font-size: 32px;
-    color: $gray-700;
-  }
-
-  .fileTitle {
-    grid-area: title;
-    font-size: 14px;
-    color: $gray-1350;
-  }
-
-  .fileInfo {
-    grid-area: info;
-    font-size: 12px;
-    color: $gray-1100;
-  }
-
-  .fileProgress {
-    grid-area: progress;
-  }
-
-  .cancelUpload {
-    grid-area: close;
-    cursor: pointer;
-  }
-
-  &.error {
-    .icon {
-      color: $error-red;
-    }
-  }
-
-  &.success {
-    .icon {
-      color: $green-500;
-    }
   }
 }
 
@@ -89,3 +41,9 @@
 .pad {
   margin: 8px;
 }
+
+.twoColumn {
+  display: grid;
+  grid-template-columns: repeat(2, 1fr);
+  gap: 1rem;
+}

apps/client/src/features/modals/upload-modal/UploadModal.tsx

@@ -1,7 +1,6 @@
-import { ChangeEvent, useCallback, useRef, useState } from 'react';
+import { useEffect, useRef, useState } from 'react';
 import {
   Button,
-  Input,
   Modal,
   ModalBody,
   ModalCloseButton,
@@ -9,23 +8,34 @@ import {
   ModalFooter,
   ModalHeader,
   ModalOverlay,
-  Progress,
-  Switch,
 } from '@chakra-ui/react';
-import { IoClose } from '@react-icons/all-files/io5/IoClose';
-import { IoDocumentTextOutline } from '@react-icons/all-files/io5/IoDocumentTextOutline';
-import { IoWarningOutline } from '@react-icons/all-files/io5/IoWarningOutline';
 import { useQueryClient } from '@tanstack/react-query';
+import { OntimeRundown, ProjectData, UserFields } from 'ontime-types';
+import { defaultExcelImportMap, ExcelImportMap } from 'ontime-utils';
 
-import { RUNDOWN_TABLE } from '../../../common/api/apiConstants';
+import { PROJECT_DATA, RUNDOWN_TABLE, USERFIELDS } from '../../../common/api/apiConstants';
-import { uploadData } from '../../../common/api/ontimeApi';
+import { invalidateAllCaches, maybeAxiosError } from '../../../common/api/apiUtils';
-import { useEmitLog } from '../../../common/stores/logger';
+import {
-import ModalSplitInput from '../ModalSplitInput';
+  patchData,
+  postPreviewExcel,
+  ProjectFileImportOptions,
+  uploadProjectFile,
+} from '../../../common/api/ontimeApi';
+import { projectDataPlaceholder } from '../../../common/models/ProjectData';
+import { userFieldsPlaceholder } from '../../../common/models/UserFields';
 
-import { validateFile } from './utils';
+import PreviewExcel from './preview/PreviewExcel';
+import ExcelFileOptions from './upload-options/ExcelFileOptions';
+import OntimeFileOptions from './upload-options/OntimeFileOptions';
+import UploadStepTracker from './upload-step/UploadStep';
+import UploadFile from './UploadFile';
+import { useUploadModalContextStore } from './uploadModalContext';
+import { getPersistedOptions, isExcelFile, isOntimeFile, persistOptions } from './uploadUtils';
 
 import style from './UploadModal.module.scss';
 
+export type UploadStep = 'import' | 'review';
+
 interface UploadModalProps {
   onClose: () => void;
   isOpen: boolean;
@@ -33,64 +43,152 @@ interface UploadModalProps {
 
 export default function UploadModal({ onClose, isOpen }: UploadModalProps) {
   const queryClient = useQueryClient();
-  const { emitError } = useEmitLog();
-  const [errors, setErrors] = useState<string | undefined>();
-  const [isSubmitting, setSubmitting] = useState(false);
-  const [file, setFile] = useState<File | null>(null);
-  const [progress, setProgress] = useState(0);
-  const overrideOptionRef = useRef<HTMLInputElement>(null);
-  const fileInputRef = useRef<HTMLInputElement>(null);
-  const [success, setSuccess] = useState(false);
 
-  const handleFile = useCallback((event: ChangeEvent<HTMLInputElement>) => {
+  const { file, setProgress, clear } = useUploadModalContextStore();
-    const fileUploaded = event?.target?.files?.[0];
-    if (!fileUploaded) return;
 
-    const validate = validateFile(fileUploaded);
+  const [uploadStep, setUploadStep] = useState<UploadStep>('import');
-    setErrors(validate.errors?.[0]);
+  const [submitting, setSubmitting] = useState(false);
+  const [rundown, setRundown] = useState<OntimeRundown | null>(null);
+  const [userFields, setUserFields] = useState<UserFields | null>(null);
+  const [project, setProject] = useState<ProjectData | null>(null);
 
-    if (validate.isValid) {
+  const [errors, setErrors] = useState('');
-      setFile(fileUploaded);
+
-    } else {
+  const ontimeFileOptions = useRef<Partial<ProjectFileImportOptions>>({});
-      setFile(null);
+  const excelFileOptions = useRef<ExcelImportMap>(defaultExcelImportMap);
+
+  const updateOntimeFileOptions = <T extends keyof ProjectFileImportOptions>(
+    field: T,
+    value: ProjectFileImportOptions[T],
+  ) => {
+    ontimeFileOptions.current = { ...ontimeFileOptions.current, [field]: value };
+  };
+
+  const updateExcelFileOptions = <T extends keyof ExcelImportMap>(field: T, value: ExcelImportMap[T]) => {
+    if (excelFileOptions.current[field] !== value) {
+      excelFileOptions.current = { ...excelFileOptions.current, [field]: value };
+    }
+  };
+
+  // We want to populate the options with any previous options given by the user
+  useEffect(() => {
+    const excelOptions = getPersistedOptions('excel');
+    if (excelOptions) {
+      excelFileOptions.current = excelOptions;
     }
   }, []);
 
-  const handleSubmit = useCallback(async () => {
+  // if the modal re-opens, we want to restart all states
-    setSubmitting(true);
+  useEffect(() => {
+    clear();
+    setUploadStep('import');
+    setSubmitting(false);
+    setRundown(null);
+    setUserFields(null);
+    setProject(null);
+    setErrors('');
+  }, [clear, isOpen]);
+
+  /* uploads file to backend
+   * - in the case of excel, we get the preview
+   * - in the case of project file, this is end of line
+   **/
+  const handleUpload = async () => {
+    let doClose = false;
     if (file) {
+      setSubmitting(true);
+      setErrors('');
       try {
-        const options = {
+        if (isOntimeFile(file)) {
-          onlyRundown: overrideOptionRef.current?.checked || false,
+          // TODO: we would also like to have preview for ontime project files
-        };
+          const options = ontimeFileOptions.current;
-        await uploadData(file, setProgress, options);
+          await handleOntimeFile(file, options);
+          await invalidateAllCaches();
+          doClose = true;
+        } else if (isExcelFile(file)) {
+          const options = excelFileOptions.current;
+          persistOptions({ optionType: 'excel', options });
+          await handleExcelFile(file, options);
+        }
       } catch (error) {
-        emitError(`Failed uploading file: ${error}`);
+        const message = maybeAxiosError(error);
+        setErrors(`Failed uploading file ${message}`);
       } finally {
-        await queryClient.invalidateQueries(RUNDOWN_TABLE);
+        setSubmitting(false);
-        setSuccess(true);
+        if (doClose) {
+          handleClose();
+        }
       }
     }
-    setSubmitting(false);
-  }, [emitError, file, queryClient]);
 
-  const handleClick = () => {
+    // when we upload excel, we populate state with preview data
-    fileInputRef.current?.click();
+    async function handleExcelFile(file: File, options: ExcelImportMap) {
-  };
+      const response = await postPreviewExcel(file, setProgress, options);
-
+      if (response.status === 200) {
-  const clearFile = () => {
+        setRundown(response.data.rundown);
-    setFile(null);
+        setUserFields(response.data.userFields);
+        setProject(response.data.project);
+        // in excel imports we have an extra review step
+        setUploadStep('review');
+      }
+    }
+
+    // when we upload project files, no extra operations are done
+    async function handleOntimeFile(file: File, options: Partial<ProjectFileImportOptions>) {
+      await uploadProjectFile(file, setProgress, options);
+    }
   };
 
+  // before closing the modal, we clear data from mutations
   const handleClose = () => {
-    clearFile();
+    clear();
-    setSuccess(false);
+    setRundown([]);
-    setErrors(undefined);
+    setUserFields(userFieldsPlaceholder);
-    setProgress(0);
+    setProject(projectDataPlaceholder);
     onClose();
   };
 
-  const disableSubmit = !file || isSubmitting;
+  const handleFinalise = async () => {
+    // this step is currently only used for excel files, after preview
+    if (isExcel && rundown && userFields && project) {
+      let doClose = false;
+      setSubmitting(true);
+      try {
+        await patchData({ rundown, userFields, project });
+        queryClient.setQueryData(RUNDOWN_TABLE, rundown);
+        queryClient.setQueryData(USERFIELDS, userFields);
+        queryClient.setQueryData(PROJECT_DATA, project);
+        await queryClient.invalidateQueries({
+          queryKey: [...RUNDOWN_TABLE, ...USERFIELDS, ...PROJECT_DATA],
+        });
+        doClose = true;
+      } catch (error) {
+        const message = maybeAxiosError(error);
+        setErrors(`Failed applying changes ${message}`);
+      } finally {
+        setSubmitting(false);
+        if (doClose) {
+          handleClose();
+        }
+      }
+    }
+  };
+
+  const undoReview = () => {
+    setUploadStep('import');
+    setErrors('');
+  };
+
+  const isImporting = uploadStep === 'import';
+  const isReview = uploadStep === 'review';
+  const isExcel = isExcelFile(file);
+  const isOntime = isOntimeFile(file);
+
+  const handleGoBack = isImporting ? undefined : undoReview;
+  const handleSubmit = isImporting ? handleUpload : handleFinalise;
+  const disableSubmit = (isImporting && !file) || (isReview && rundown === null);
+  const disableGoBack = isImporting;
+  const submitText = isImporting ? 'Import' : 'Finish';
 
   return (
     <Modal
@@ -101,66 +199,50 @@ export default function UploadModal({ onClose, isOpen }: UploadModalProps) {
       size='xl'
       scrollBehavior='inside'
       preserveScrollBarGap
-      variant='ontime-small'
+      variant='ontime-upload'
     >
       <ModalOverlay />
       <ModalContent>
         <ModalHeader>File import</ModalHeader>
         <ModalCloseButton />
         <ModalBody className={style.uploadBody}>
-          <Input
+          {isExcel && <UploadStepTracker uploadStep={uploadStep} />}
-            ref={fileInputRef}
+          {uploadStep === 'import' ? (
-            style={{ display: 'none' }}
+            <>
-            type='file'
+              <UploadFile />
-            onChange={handleFile}
+              {isOntime && <OntimeFileOptions optionsRef={ontimeFileOptions} updateOptions={updateOntimeFileOptions} />}
-            accept='.json, .xlsx'
+              {isExcel && <ExcelFileOptions optionsRef={excelFileOptions} updateOptions={updateExcelFileOptions} />}
-            data-testid='file-input'
+            </>
-          />
+          ) : (
-          <div className={style.uploadArea} onClick={handleClick}>
+            <PreviewExcel
-            Click to upload Ontime project file
+              rundown={rundown ?? []}
-          </div>
+              project={project ?? projectDataPlaceholder}
-          {file && (
+              userFields={userFields ?? userFieldsPlaceholder}
-            <div className={`${style.uploadedItem} ${success ? style.success : ''}`}>
+            />
-              <IoClose className={style.cancelUpload} onClick={clearFile} />
-              <IoDocumentTextOutline className={style.icon} />
-              <span className={style.fileTitle}>{file.name}</span>
-              <span className={style.fileInfo}>{`${(file.size / 1024).toFixed(2)}kb - ${file.type}`}</span>
-              <Progress variant='ontime-on-light' className={style.fileProgress} value={progress} />
-            </div>
           )}
-          {errors && (
-            <div className={`${style.uploadedItem} ${style.error}`}>
-              <IoWarningOutline className={style.icon} />
-              <span className={style.fileTitle}>{errors}</span>
-              <span className={style.fileInfo}>Please try again</span>
-              <Progress className={style.fileProgress} value={progress} />
-            </div>
-          )}
-          <div className={style.uploadOptions}>
-            <span className={style.title}>Import options</span>
-            <ModalSplitInput
-              field=''
-              title='Only import rundown'
-              description='All other options, including application settings will be discarded'
-            >
-              <Switch variant='ontime-on-light' ref={overrideOptionRef} />
-            </ModalSplitInput>
-          </div>
         </ModalBody>
-        <ModalFooter className={`${style.buttonSection} ${style.pad}`}>
+        <ModalFooter>
-          <Button onClick={handleClose} isDisabled={isSubmitting} variant='ontime-ghost-on-light' size='sm'>
+          <div className={style.feedbackSection}>{errors && <div className={style.error}>{errors}</div>}</div>
-            Cancel
+          <div className={`${style.buttonSection} ${style.pad}`}>
-          </Button>
+            <Button
-          <Button
+              onClick={handleGoBack}
-            onClick={handleSubmit}
+              isDisabled={disableGoBack || submitting}
-            isLoading={isSubmitting}
+              variant='ontime-ghost-on-light'
-            isDisabled={disableSubmit}
+              size='sm'
-            variant='ontime-filled'
+            >
-            padding='0 2em'
+              Go Back
-            size='sm'
+            </Button>
-          >
+            <Button
-            Import
+              onClick={handleSubmit}
-          </Button>
+              isLoading={submitting}
+              isDisabled={disableSubmit}
+              variant='ontime-filled'
+              padding='0 2em'
+              size='sm'
+            >
+              {submitText}
+            </Button>
+          </div>
         </ModalFooter>
       </ModalContent>
     </Modal>

apps/client/src/features/modals/upload-modal/preview/PreviewColumn.module.scss

@@ -0,0 +1,22 @@
+@use "../../../../theme/_ontimeColours" as *;
+
+@mixin pad-item {
+  padding-left: 0.5rem;
+  padding-right: 1rem;
+}
+
+.previewTable {
+  display: grid;
+  grid-template-columns: auto 1fr;
+  grid-template-rows: repeat(6, auto);
+  font-size: calc(1rem - 2px);
+}
+
+.field {
+  font-weight: 200;
+  @include pad-item;
+}
+
+.value {
+  @include pad-item;
+}

apps/client/src/features/modals/upload-modal/preview/PreviewExcel.tsx

@@ -0,0 +1,26 @@
+import { OntimeRundown, ProjectData, UserFields } from 'ontime-types';
+
+import PreviewProjectData from './PreviewProjectData';
+import PreviewRundown from './PreviewRundown';
+
+import style from '../../Modal.module.scss';
+
+interface PreviewExcelProps {
+  rundown: OntimeRundown;
+  project: ProjectData;
+  userFields: UserFields;
+}
+
+export default function PreviewExcel(props: PreviewExcelProps) {
+  const { rundown, project, userFields } = props;
+
+  return (
+    <div className={`${style.column}`}>
+      <div className={style.title}>Review Project Data</div>
+      <PreviewProjectData project={project} />
+      <div className={style.vSpacer} />
+      <div className={style.title}>Review Rundown</div>
+      <PreviewRundown rundown={rundown} userFields={userFields} />
+    </div>
+  );
+}

apps/client/src/features/modals/upload-modal/preview/PreviewProjectData.tsx

@@ -0,0 +1,26 @@
+import { ProjectData } from 'ontime-types';
+
+import style from './PreviewColumn.module.scss';
+
+interface PreviewProjectDataProps {
+  project: ProjectData;
+}
+
+export default function PreviewProjectData({ project }: PreviewProjectDataProps) {
+  return (
+    <div className={style.previewTable}>
+      <span className={style.field}>Title</span>
+      <span className={style.value}>{project.title}</span>
+      <span className={style.field}>Description</span>
+      <span className={style.value}>{project.description}</span>
+      <span className={style.field}>Public URL</span>
+      <span className={style.value}>{project.publicUrl}</span>
+      <span className={style.field}>Public info</span>
+      <span className={style.value}>{project.publicInfo}</span>
+      <span className={style.field}>Backstage URL</span>
+      <span className={style.value}>{project.backstageUrl}</span>
+      <span className={style.field}>Backstage info</span>
+      <span className={style.value}>{project.backstageInfo}</span>
+    </div>
+  );
+}

apps/client/src/features/modals/upload-modal/preview/PreviewRundown.tsx

@@ -0,0 +1,131 @@
+import { Fragment } from 'react';
+import { isOntimeEvent, OntimeRundown, UserFields } from 'ontime-types';
+import { millisToString } from 'ontime-utils';
+
+import { getAccessibleColour } from '../../../../common/utils/styleUtils';
+
+import Tag from './Tag';
+
+import style from './PreviewTable.module.scss';
+
+interface PreviewRundownProps {
+  rundown: OntimeRundown;
+  userFields: UserFields;
+}
+
+function booleanToText(value?: boolean) {
+  return value ? 'Yes' : undefined;
+}
+
+export default function PreviewRundown({ rundown, userFields }: PreviewRundownProps) {
+  return (
+    <div className={style.container}>
+      <table className={style.rundownPreview}>
+        <thead className={style.header}>
+          <tr>
+            <th>#</th>
+            <th>Type</th>
+            <th>Cue</th>
+            <th>Title</th>
+            <th>Subtitle</th>
+            <th>Presenter</th>
+            <th>Time Start</th>
+            <th>Time End</th>
+            <th>Duration</th>
+            <th>Is Public</th>
+            <th>Skip</th>
+            <th>Colour</th>
+            <th>Timer Type</th>
+            <th>End Action</th>
+            <th>
+              user0 <Tag>{userFields.user0}</Tag>
+            </th>
+            <th>
+              user1 <Tag>{userFields.user1}</Tag>
+            </th>
+            <th>
+              user2 <Tag>{userFields.user2}</Tag>
+            </th>
+            <th>
+              user3 <Tag>{userFields.user3}</Tag>
+            </th>
+            <th>
+              user4 <Tag>{userFields.user4}</Tag>
+            </th>
+            <th>
+              user5 <Tag>{userFields.user5}</Tag>
+            </th>
+            <th>
+              user6 <Tag>{userFields.user6}</Tag>
+            </th>
+            <th>
+              user7 <Tag>{userFields.user7}</Tag>
+            </th>
+            <th>
+              user8 <Tag>{userFields.user8}</Tag>
+            </th>
+            <th>
+              user9 <Tag>{userFields.user9}</Tag>
+            </th>
+          </tr>
+        </thead>
+        <tbody className={style.body}>
+          {rundown.map((event, index) => {
+            if (!isOntimeEvent(event)) {
+              return null;
+            }
+            const key = event.id;
+            const colour = event.colour ? getAccessibleColour(event.colour) : {};
+            const isPublic = booleanToText(event.isPublic);
+            const skip = booleanToText(event.skip);
+            return (
+              <Fragment key={key}>
+                <tr>
+                  <td className={style.center}>
+                    <Tag>{index + 1}</Tag>
+                  </td>
+                  <td className={style.center}>
+                    <Tag>Event</Tag>
+                  </td>
+                  <td className={style.nowrap}>{event.cue}</td>
+                  <td>{event.title}</td>
+                  <td>{event.subtitle}</td>
+                  <td>{event.presenter}</td>
+                  <td>{millisToString(event.timeStart)}</td>
+                  <td>{millisToString(event.timeEnd)}</td>
+                  <td>{millisToString(event.duration)}</td>
+                  <td className={style.center}>{isPublic && <Tag>{isPublic}</Tag>}</td>
+                  <td>{skip && <Tag>{skip}</Tag>}</td>
+                  <td style={{ ...colour }}>{event.colour}</td>
+                  <td className={style.center}>
+                    <Tag>{event.timerType}</Tag>
+                  </td>
+                  <td className={style.center}>
+                    <Tag>{event.endAction}</Tag>
+                  </td>
+                  <td>{event.user0}</td>
+                  <td>{event.user1}</td>
+                  <td>{event.user2}</td>
+                  <td>{event.user3}</td>
+                  <td>{event.user4}</td>
+                  <td>{event.user5}</td>
+                  <td>{event.user6}</td>
+                  <td>{event.user7}</td>
+                  <td>{event.user8}</td>
+                  <td>{event.user9}</td>
+                </tr>
+                {event.note && (
+                  <tr>
+                    <td colSpan={99} className={style.secondaryRow}>
+                      Note: {event.note}
+                    </td>
+                  </tr>
+                )}
+              </Fragment>
+            );
+          })}
+        </tbody>
+      </table>
+    </div>
+  );
+}

apps/client/src/features/modals/upload-modal/preview/PreviewTable.module.scss

@@ -0,0 +1,71 @@
+@use "../../../../theme/_ontimeColours" as *;
+
+.container {
+  max-width: 100%;
+  max-height: max(300px, 30vh);
+  overflow: scroll;
+}
+
+.rundownPreview {
+  font-size: calc(1rem - 2px);
+  overflow-x: scroll;
+}
+
+.header,
+.body {
+  th {
+    font-weight: 400;
+    height: unset;
+    line-height: calc(1rem - 2px);
+    white-space: nowrap;
+    padding-left: 0.25rem;
+    padding-right: 1rem;
+  }
+}
+
+.header {
+  position: sticky;
+  top: 0;
+  background-color: white;
+  box-shadow: 0 2px $gray-50;
+  z-index: 3;
+
+  th {
+    font-weight: 200;
+    text-align: left;
+  }
+
+  tr {
+    word-wrap: unset;
+  }
+}
+
+.body {
+  td {
+    text-align: left;
+    vertical-align: top;
+    padding: 0 0.5em;
+  }
+
+  .center {
+    text-align: center;
+  }
+
+  .nowrap {
+    white-space: nowrap;
+  }
+
+  .secondaryRow {
+    padding: 0.25em 0.25em;
+    background-color: $gray-50;
+  }
+}
+
+table tr td:first-child,
+table tr th:first-child {
+  position: sticky;
+  left: 0;
+  z-index: 2;
+  background-color: white;
+  box-shadow: 1px 0 $gray-50;
+}

apps/client/src/features/modals/upload-modal/preview/Tag.module.scss

@@ -0,0 +1,11 @@
+@use "../../../../theme/_ontimeColours" as *;
+
+.tag {
+  font-size: calc(1rem - 3px);
+  letter-spacing: 0.5px;
+  background-color: $gray-100;
+  color: $ui-black;
+  border-radius: 2px;
+  padding: 0 0.25rem;
+  white-space: nowrap;
+}

apps/client/src/features/modals/upload-modal/preview/Tag.tsx

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+
+import style from './Tag.module.scss';
+
+export default function Tag({ children }: { children: ReactNode }) {
+  return <span className={style.tag}>{children}</span>;
+}

apps/client/src/features/modals/upload-modal/upload-entry/UploadEntry.module.scss

@@ -0,0 +1,53 @@
+@use '../../../../theme/ontimeColours' as *;
+@use '../../../../theme/v2Styles' as *;
+
+.uploadedItem {
+  margin: 0 auto;
+  width: 100%;
+  max-width: 550px;
+
+  border: 1px solid $gray-200;
+  padding: 0.5rem;
+  display: grid;
+  grid-template-areas:
+          "icon     title     close"
+          "icon     info      ."
+          "progress progress  progress";
+  grid-template-columns: auto 1fr auto;
+  column-gap: 1rem;
+  border-radius: 3px;
+
+  .icon {
+    align-self: center;
+    grid-area: icon;
+    font-size: 2rem;
+    color: $gray-700;
+  }
+
+  .fileTitle {
+    grid-area: title;
+    font-size: calc(1rem - 2px);
+    color: $ui-black;
+  }
+
+  .fileInfo {
+    grid-area: info;
+    font-size: calc(1rem - 4px);
+    color: $gray-1100;
+  }
+
+  .fileProgress {
+    grid-area: progress;
+  }
+
+  .cancelUpload {
+    grid-area: close;
+    cursor: pointer;
+  }
+
+  &.error {
+    .icon {
+      color: $error-red;
+    }
+  }
+}

apps/client/src/features/modals/upload-modal/upload-entry/UploadEntry.tsx

@@ -0,0 +1,52 @@
+import { Progress } from '@chakra-ui/react';
+import { IoClose } from '@react-icons/all-files/io5/IoClose';
+import { IoDocumentTextOutline } from '@react-icons/all-files/io5/IoDocumentTextOutline';
+import { IoWarningOutline } from '@react-icons/all-files/io5/IoWarningOutline';
+
+import { isExcelFile, isOntimeFile } from '../uploadUtils';
+
+import style from './UploadEntry.module.scss';
+
+interface UploadEntryProps {
+  file: File | null;
+  errors?: string;
+  progress: number;
+  handleClear: () => void;
+}
+
+export default function UploadEntry(props: UploadEntryProps) {
+  const { file, errors, progress, handleClear } = props;
+
+  if (errors) {
+    return (
+      <div className={`${style.uploadedItem} ${style.error}`}>
+        <IoClose className={style.cancelUpload} onClick={handleClear} />
+        <IoWarningOutline className={style.icon} />
+        <span className={style.fileTitle}>{errors}</span>
+        <span className={style.fileInfo}>Please try again</span>
+      </div>
+    );
+  }
+
+  if (file) {
+    const fileSize = `${(file.size / 1024).toFixed(2)}kb`;
+    let fileType = '';
+    if (isOntimeFile(file)) {
+      fileType = 'Ontime Project File';
+    } else if (isExcelFile(file)) {
+      fileType = 'Excel Rundown';
+    }
+
+    return (
+      <div className={style.uploadedItem}>
+        <IoClose className={style.cancelUpload} onClick={handleClear} />
+        <IoDocumentTextOutline className={style.icon} />
+        <span className={style.fileTitle}>{file.name}</span>
+        <span className={style.fileInfo}>{`${fileSize} - ${fileType}`}</span>
+        <Progress variant='ontime-on-light' className={style.fileProgress} value={progress} />
+      </div>
+    );
+  }
+
+  return null;
+}

apps/client/src/features/modals/upload-modal/upload-options/ExcelFileOptions.tsx

@@ -0,0 +1,70 @@
+import { MutableRefObject } from 'react';
+import { ExcelImportMap } from 'ontime-utils';
+
+import ImportMapTable, { type TableEntry } from './ImportMapTable';
+
+import style from '../UploadModal.module.scss';
+
+interface ExcelFileOptionsProps {
+  optionsRef: MutableRefObject<ExcelImportMap>;
+  updateOptions: <T extends keyof ExcelImportMap>(field: T, value: ExcelImportMap[T]) => void;
+}
+
+export default function ExcelFileOptions(props: ExcelFileOptionsProps) {
+  const { optionsRef, updateOptions } = props;
+
+  const worksheet: TableEntry[] = [{ label: 'Worksheet', title: 'worksheet', value: optionsRef.current.worksheet }];
+
+  const timings: TableEntry[] = [
+    { label: 'Start time', title: 'timeStart', value: optionsRef.current.timeStart },
+    { label: 'End Time', title: 'timeEnd', value: optionsRef.current.timeEnd },
+    { label: 'Duration', title: 'duration', value: optionsRef.current.duration },
+  ];
+
+  const titles: TableEntry[] = [
+    { label: 'Cue', title: 'cue', value: optionsRef.current.cue },
+    { label: 'Colour', title: 'colour', value: optionsRef.current.colour },
+    { label: 'Title', title: 'title', value: optionsRef.current.title },
+    { label: 'Presenter', title: 'presenter', value: optionsRef.current.presenter },
+    { label: 'Subtitle', title: 'subtitle', value: optionsRef.current.subtitle },
+    { label: 'Note', title: 'note', value: optionsRef.current.note },
+  ];
+
+  const options: TableEntry[] = [
+    { label: 'Is Public', title: 'isPublic', value: optionsRef.current.isPublic },
+    { label: 'Skip', title: 'skip', value: optionsRef.current.skip },
+    { label: 'Timer Type', title: 'timerType', value: optionsRef.current.timerType },
+    { label: 'End Action', title: 'endAction', value: optionsRef.current.endAction },
+  ];
+
+  const userFields: TableEntry[] = [
+    { label: 'User 0', title: 'user0', value: optionsRef.current.user0 },
+    { label: 'User 1', title: 'user1', value: optionsRef.current.user1 },
+    { label: 'User 2', title: 'user2', value: optionsRef.current.user2 },
+    { label: 'User 3', title: 'user3', value: optionsRef.current.user3 },
+    { label: 'User 4', title: 'user4', value: optionsRef.current.user4 },
+    { label: 'User 5', title: 'user5', value: optionsRef.current.user5 },
+    { label: 'User 6', title: 'user6', value: optionsRef.current.user6 },
+    { label: 'User 7', title: 'user7', value: optionsRef.current.user7 },
+    { label: 'User 8', title: 'user8', value: optionsRef.current.user8 },
+    { label: 'User 9', title: 'user9', value: optionsRef.current.user9 },
+  ];
+
+  return (
+    <div className={style.uploadOptions}>
+      <div className={style.twoEqualColumn}>
+        <ImportMapTable title='Sheet settings' fields={worksheet} handleOnChange={updateOptions} />
+      </div>
+
+      <div className={style.twoEqualColumn}>
+        <ImportMapTable title='Timings' fields={timings} handleOnChange={updateOptions} />
+        <ImportMapTable title='Options' fields={options} handleOnChange={updateOptions} />
+      </div>
+
+      <div className={style.twoEqualColumn}>
+        <ImportMapTable title='Titles' fields={titles} handleOnChange={updateOptions} />
+        <ImportMapTable title='User Fields' fields={userFields} handleOnChange={updateOptions} />
+      </div>
+    </div>
+  );
+}

apps/client/src/features/modals/upload-modal/upload-options/ImportMapTable.module.scss

@@ -0,0 +1,33 @@
+@use '../../../../theme/v2Styles' as *;
+@use '../../../../theme/ontimeColours' as *;
+
+.importTable {
+  margin: 0.5rem;
+  height: fit-content;
+
+  thead {
+    color: $gray-500;
+    text-transform: uppercase;
+    width: 10em;
+  }
+
+  tr:hover {
+    background-color: $gray-50;
+  }
+
+  tbody {
+    td {
+      max-width: fit-content;
+    }
+  }
+}
+
+.label {
+  display: inline-block;
+  min-width: 6em;
+  font-size: $inner-section-text-size;
+}
+
+.input {
+  width: 100%;
+}

apps/client/src/features/modals/upload-modal/upload-options/ImportMapTable.tsx

@@ -0,0 +1,50 @@
+import { Input } from '@chakra-ui/react';
+import { ExcelImportMap } from 'ontime-utils';
+
+import style from './ImportMapTable.module.scss';
+
+export type TableEntry = { label: string; title: keyof ExcelImportMap; value: string };
+
+interface ImportMapTableProps {
+  title: string;
+  fields: TableEntry[];
+  handleOnChange: (field: keyof ExcelImportMap, value: string) => void;
+}
+
+export default function ImportMapTable(props: ImportMapTableProps) {
+  const { title, fields, handleOnChange } = props;
+
+  return (
+    <table className={style.importTable}>
+      <thead>
+        <tr>
+          <td colSpan={2}>{title}</td>
+        </tr>
+      </thead>
+      <tbody>
+        {fields.map((field) => {
+          return (
+            <tr key={field.title}>
+              <td className={style.label}>
+                <label htmlFor={field.title}>{field.label}</label>
+              </td>
+              <td className={style.input}>
+                <Input
+                  id={field.title}
+                  size='xs'
+                  variant='ontime-filled-on-light'
+                  maxLength={25}
+                  defaultValue={field.value}
+                  placeholder='Use default column name'
+                  onBlur={(event) => {
+                    handleOnChange(field.title, event.target.value);
+                  }}
+                />
+              </td>
+            </tr>
+          );
+        })}
+      </tbody>
+    </table>
+  );
+}

apps/client/src/features/modals/upload-modal/upload-options/OntimeFileOptions.tsx

@@ -0,0 +1,31 @@
+import { MutableRefObject } from 'react';
+import { Switch } from '@chakra-ui/react';
+
+import { ProjectFileImportOptions } from '../../../../common/api/ontimeApi';
+import ModalSplitInput from '../../ModalSplitInput';
+
+import style from '../UploadModal.module.scss';
+
+interface OntimeFileOptionsProps {
+  optionsRef: MutableRefObject<Partial<ProjectFileImportOptions>>;
+  updateOptions: <T extends keyof ProjectFileImportOptions>(field: T, value: ProjectFileImportOptions[T]) => void;
+}
+
+export default function OntimeFileOptions(props: OntimeFileOptionsProps) {
+  const { optionsRef, updateOptions } = props;
+
+  return (
+    <div className={style.uploadOptions}>
+      <span className={style.title}>Import options</span>
+      <ModalSplitInput field='' title='Only import rundown' description='All other project options will be kept'>
+        <Switch
+          variant='ontime-on-light'
+          onChange={(e) => {
+            updateOptions('onlyRundown', e.target.checked);
+          }}
+          defaultChecked={Boolean(optionsRef.current.onlyRundown)}
+        />
+      </ModalSplitInput>
+    </div>
+  );
+}

apps/client/src/features/modals/upload-modal/upload-step/UploadStep.module.scss

@@ -0,0 +1,40 @@
+@use '../../../../theme/ontimeColours' as *;
+
+@mixin row {
+  display: flex;
+  align-items: center;
+  gap: 0.25rem;
+  padding: 0 0.25rem;
+}
+
+.stepRow {
+  display: flex;
+  gap: 2rem;
+  align-items: center;
+  margin: 0 auto;
+  font-size: 1rem;
+}
+
+.idle {
+  @include row;
+  color: $blue-500;
+}
+
+.inactive {
+  @include row;
+  color: $gray-700;
+}
+
+.active {
+  @include row;
+  color: $blue-700;
+}
+
+
+.inactiveIcon {
+  color: $gray-700;
+}
+
+.activeIcon {
+  color: $blue-500;
+}

apps/client/src/features/modals/upload-modal/upload-step/UploadStep.tsx

@@ -0,0 +1,26 @@
+import { IoCheckmarkCircle } from '@react-icons/all-files/io5/IoCheckmarkCircle';
+import { IoChevronForward } from '@react-icons/all-files/io5/IoChevronForward';
+import { IoEllipseOutline } from '@react-icons/all-files/io5/IoEllipseOutline';
+
+import type { UploadStep } from '../UploadModal';
+
+import style from './UploadStep.module.scss';
+
+export default function UploadStepTracker({ uploadStep }: { uploadStep: UploadStep }) {
+  const isImporting = uploadStep === 'import';
+  const isReview = uploadStep === 'review';
+
+  return (
+    <div className={style.stepRow}>
+      <div className={isImporting ? style.active : style.idle}>
+        <IoCheckmarkCircle />
+        Import
+      </div>
+      <IoChevronForward className={isReview ? style.activeIcon : style.inactiveIcon} />
+      <div className={isReview ? style.active : style.inactive}>
+        {isReview ? <IoCheckmarkCircle /> : <IoEllipseOutline />}
+        Review
+      </div>
+    </div>
+  );
+}

apps/client/src/features/modals/upload-modal/uploadModalContext.tsx

@@ -0,0 +1,21 @@
+import { create } from 'zustand';
+
+type UploadModalContext = {
+  file: File | null;
+  setFile: (file: File | null) => void;
+
+  progress: number;
+  setProgress: (progress: number) => void;
+
+  clear: () => void;
+};
+
+export const useUploadModalContextStore = create<UploadModalContext>((set) => ({
+  file: null,
+  setFile: (file: File | null) => set({ file }),
+
+  progress: 0,
+  setProgress: (progress: number) => set({ progress }),
+
+  clear: () => set({ file: null, progress: 0 }),
+}));

apps/client/src/features/modals/upload-modal/uploadUtils.ts

@@ -0,0 +1,64 @@
+import { ExcelImportMap } from 'ontime-utils';
+
+import { ProjectFileImportOptions } from '../../../common/api/ontimeApi';
+
+/**
+ * Validates a file according to the app upload contract
+ * @throws
+ * @param file
+ */
+export function validateFile(file: File) {
+  if (!file) {
+    throw new Error('No file to upload');
+  }
+
+  // Check if file is empty
+  if (file.size === 0) {
+    throw new Error('File is empty');
+  }
+
+  // Limit file size of a project file to around 1MB
+  if (file.name.endsWith('.json') && file.size > 1_000_000) {
+    throw new Error('File size limit (1MB) exceeded');
+  }
+
+  // Limit file size of an excel file to around 10MB
+  if (file.name.endsWith('.xlsx') && file.size > 10_000_000) {
+    throw new Error('File size limit (10MB) exceeded');
+  }
+
+  // Check file extension
+  if (!file.name.endsWith('.xlsx') && !file.name.endsWith('.json')) {
+    throw new Error('Unhandled file type');
+  }
+}
+
+export function isExcelFile(file: File | null) {
+  return file?.name.endsWith('.xlsx');
+}
+
+export function isOntimeFile(file: File | null) {
+  return file?.name.endsWith('.json');
+}
+
+type PersistedOntimeOptions = {
+  optionType: 'ontime';
+  options: Partial<ProjectFileImportOptions>;
+};
+
+type PersistedExcelOptions = {
+  optionType: 'excel';
+  options: ExcelImportMap;
+};
+
+export function persistOptions(options: PersistedOntimeOptions | PersistedExcelOptions) {
+  localStorage.setItem(`ontime-import-options-${options.optionType}`, JSON.stringify(options.options));
+}
+
+export function getPersistedOptions(optionType: 'excel' | 'ontime') {
+  const options = localStorage.getItem(`ontime-import-options-${optionType}`);
+  if (!options) {
+    return null;
+  }
+  return JSON.parse(options);
+}

apps/client/src/features/modals/upload-modal/utils.ts

@@ -1,25 +0,0 @@
-type ValidationStatus = {
-  errors: string[];
-  isValid: boolean;
-};
-
-export function validateFile(file: File): ValidationStatus {
-  const status: ValidationStatus = { errors: [], isValid: true };
-  if (!file) {
-    status.errors.push('No file to upload');
-    status.isValid = false;
-  }
-
-  // Limit file size to 1MB
-  if (file.size > 1000000) {
-    status.errors.push('File size limit (1MB) exceeded');
-    status.isValid = false;
-  }
-
-  // Check file extension
-  if (!file.name.endsWith('.xlsx') && !file.name.endsWith('.json')) {
-    status.errors.push('Unhandled file type');
-    status.isValid = false;
-  }
-  return status;
-}

apps/client/src/features/rundown/event-block/EventBlock.module.scss

@@ -175,6 +175,9 @@ $skip-opacity: 0.1;
   font-size: calc(1rem - 3px);
   color: $block-text-color;
   line-height: calc(1rem - 3px);
+
+  max-height: 2rem;
+  overflow-y: hidden;
 }
 
 

apps/client/src/features/rundown/event-block/composite/BlockActionMenu.tsx

@@ -13,7 +13,7 @@ import { EventItemActions } from '../../RundownEntry';
 interface BlockActionMenuProps {
   enableDelete?: boolean;
   showClone?: boolean;
-  actionHandler: (action: EventItemActions, payload?: any) => void;
+  actionHandler: (action: EventItemActions, payload?: unknown) => void;
   className?: string;
 }
 

apps/client/src/features/viewers/ViewWrapper.tsx

@@ -1,5 +1,6 @@
 /* eslint-disable react/display-name */
 import { ComponentType, useMemo } from 'react';
+import { SupportedEvent } from 'ontime-types';
 import { useStore } from 'zustand';
 
 import useProjectData from '../../common/hooks-query/useProjectData';
@@ -20,7 +21,7 @@ const withData = <P extends object>(Component: ComponentType<P>) => {
 
     const publicEvents = useMemo(() => {
       if (Array.isArray(rundownData)) {
-        return rundownData.filter((e) => e.type === 'event' && e.title && e.isPublic);
+        return rundownData.filter((e) => e.type === SupportedEvent.Event && e.title && e.isPublic);
       }
       return [];
     }, [rundownData]);

apps/client/src/features/viewers/backstage/Backstage.scss

@@ -89,7 +89,10 @@
     border-radius: 8px;
 
     &.blink {
-      animation: blink 0.5s ease-in-out 3;
+      animation-name: blink;
+      animation-timing-function: ease-in-out;
+      animation-iteration-count: 3;
+      animation-duration: 1s;
     }
   }
 
@@ -99,7 +102,11 @@
     margin-top: 2em;
     padding-top: 1em;
     display: flex;
-    gap: 7.5em;
+  }
+
+  .timer-gap {
+    flex: 1;
+    max-width: 7.5em;
   }
 
   .aux-timers {
@@ -159,9 +166,12 @@
 
 @keyframes blink {
   0% {
+    background-color: var(--card-background-color-override, $viewer-card-bg-color);
+  }
+  50% {
     background-color: var(--card-background-color-blink-override, $playback-start);
   }
-  20% {
+  100% {
     background-color: var(--card-background-color-override, $viewer-card-bg-color);
   }
 }

apps/client/src/features/viewers/backstage/Backstage.tsx

@@ -11,7 +11,7 @@ import Schedule from '../../../common/components/schedule/Schedule';
 import { ScheduleProvider } from '../../../common/components/schedule/ScheduleContext';
 import ScheduleNav from '../../../common/components/schedule/ScheduleNav';
 import TitleCard from '../../../common/components/title-card/TitleCard';
-import { TIME_FORMAT_OPTION } from '../../../common/components/view-params-editor/constants';
+import { BACKSTAGE_OPTIONS } from '../../../common/components/view-params-editor/constants';
 import ViewParamsEditor from '../../../common/components/view-params-editor/ViewParamsEditor';
 import { useRuntimeStylesheet } from '../../../common/hooks/useRuntimeStylesheet';
 import { TimeManagerType } from '../../../common/models/TimeManager.type';
@@ -92,7 +92,7 @@ export default function Backstage(props: BackstageProps) {
   return (
     <div className={`backstage ${isMirrored ? 'mirror' : ''}`} data-testid='backstage-view'>
       <NavigationMenu />
-      <ViewParamsEditor paramFields={[TIME_FORMAT_OPTION]} />
+      <ViewParamsEditor paramFields={BACKSTAGE_OPTIONS} />
       <div className='project-header'>
         {general.title}
         <div className='clock-container'>
@@ -130,10 +130,12 @@ export default function Backstage(props: BackstageProps) {
                   <div className='aux-timers__label'>{getLocalizedString('common.started_at')}</div>
                   <div className='aux-timers__value'>{startedAt}</div>
                 </div>
+                <div className='timer-gap' />
                 <div className='aux-timers'>
                   <div className='aux-timers__label'>{getLocalizedString('common.expected_finish')}</div>
                   <div className='aux-timers__value'>{expectedFinish}</div>
                 </div>
+                <div className='timer-gap' />
                 <div className='aux-timers'>
                   <div className='aux-timers__label'>{getLocalizedString('common.stage_timer')}</div>
                   <div className='aux-timers__value'>{stageTimer}</div>

apps/client/src/features/viewers/public/Public.tsx

@@ -9,7 +9,7 @@ import Schedule from '../../../common/components/schedule/Schedule';
 import { ScheduleProvider } from '../../../common/components/schedule/ScheduleContext';
 import ScheduleNav from '../../../common/components/schedule/ScheduleNav';
 import TitleCard from '../../../common/components/title-card/TitleCard';
-import { TIME_FORMAT_OPTION } from '../../../common/components/view-params-editor/constants';
+import { PUBLIC_OPTIONS } from '../../../common/components/view-params-editor/constants';
 import ViewParamsEditor from '../../../common/components/view-params-editor/ViewParamsEditor';
 import { useRuntimeStylesheet } from '../../../common/hooks/useRuntimeStylesheet';
 import { TimeManagerType } from '../../../common/models/TimeManager.type';
@@ -58,7 +58,7 @@ export default function Public(props: BackstageProps) {
   return (
     <div className={`public-screen ${isMirrored ? 'mirror' : ''}`} data-testid='public-view'>
       <NavigationMenu />
-      <ViewParamsEditor paramFields={[TIME_FORMAT_OPTION]} />
+      <ViewParamsEditor paramFields={PUBLIC_OPTIONS} />
       <div className='project-header'>
         {general.title}
         <div className='clock-container'>

apps/client/src/theme/OntimeProgress.ts

@@ -0,0 +1,8 @@
+export const ontimeProgressGray = {
+  track: {
+    background: '#f6f6f6', // $gray-500
+  },
+  filledTrack: {
+    background: '#578AF4', // $blue-500
+  },
+};

apps/client/src/theme/ontimeModal.ts

@@ -2,8 +2,8 @@ export const ontimeModal = {
   header: {
     fontWeight: 400,
     letterSpacing: '0.3px',
-    padding: '16px 24px',
+    padding: '1rem 1.5rem',
-    fontSize: '20px',
+    fontSize: '1.25rem',
     color: '#202020', // $gray-50
   },
   dialog: {
@@ -20,17 +20,29 @@ export const ontimeModal = {
     color: '#202020', // $gray-50
   },
   footer: {
-    padding: '8px',
+    padding: '0.5rem',
   },
 };
 
 export const ontimeSmallModal = {
   ...ontimeModal,
   body: {
-    padding: '16px',
+    padding: '1rem',
-    fontSize: '14px',
+    fontSize: 'calc(1rem - 2px)',
   },
   dialog: {
     minHeight: 'min(200px, 10vh)',
   },
 };
+
+export const ontimeUploadModal = {
+  ...ontimeSmallModal,
+  body: {
+    padding: '1rem',
+    fontSize: 'calc(1rem - 2px)',
+  },
+  dialog: {
+    minHeight: 'min(200px, 10vh)',
+    maxWidth: 'min(800px, 80vh)',
+  },
+};

apps/client/src/theme/theme.ts

@@ -13,7 +13,8 @@ import {
 import { ontimeCheckboxOnDark } from './ontimeCheckbox';
 import { ontimeEditable } from './ontimeEditable';
 import { ontimeMenuOnDark } from './ontimeMenu';
-import { ontimeModal, ontimeSmallModal } from './ontimeModal';
+import { ontimeModal, ontimeSmallModal, ontimeUploadModal } from './ontimeModal';
+import { ontimeProgressGray } from './OntimeProgress';
 import { ontimeBlockRadio } from './ontimeRadio';
 import { ontimeSelect } from './ontimeSelect';
 import { lightSwitch, ontimeSwitch } from './ontimeSwitch';
@@ -79,6 +80,12 @@ const theme = extendTheme({
       variants: {
         ontime: { ...ontimeModal },
         'ontime-small': { ...ontimeSmallModal },
+        'ontime-upload': { ...ontimeUploadModal },
+      },
+    },
+    Progress: {
+      variants: {
+        'ontime-on-light': { ...ontimeProgressGray },
       },
     },
     Radio: {

apps/electron/.eslintrc

@@ -3,11 +3,14 @@
     "sourceType": "module"
   },
   "env": {
+    "browser": true,
     "node": true
   },
   "extends": [
     "eslint:recommended"
   ],
   "plugins": [],
-  "rules": {}
+  "rules": {
+    "@typescript-eslint/no-var-requires": "off"
+  }
 }

apps/electron/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ontime",
-  "version": "2.9.0",
+  "version": "2.16.2",
   "author": "Carlos Valente",
   "description": "Time keeping for live events",
   "repository": "https://github.com/cpvalente/ontime",
@@ -14,13 +14,14 @@
   "devDependencies": {
     "electron": "^22.3.5",
     "electron-builder": "^23.6.0",
-    "eslint": "^8.31.0",
+    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-prettier": "^9.0.0",
-    "prettier": "^2.8.3"
+    "prettier": "^3.0.3"
   },
   "scripts": {
     "postinstall": "",
-    "dev:electron": "NODE_ENV=development electron .",
+    "lint": "eslint . --quiet",
+    "dev:electron": "cross-env NODE_ENV=development electron .",
     "dist-win": "electron-builder --publish=never  --x64 --win",
     "dist-mac": "electron-builder --publish=never  --mac",
     "dist-linux": "electron-builder --publish=never  --x64 --linux",

apps/electron/src/menu/applicationMenu.js

@@ -8,23 +8,23 @@ function getApplicationMenu(isMac, askToQuit) {
   return [
     ...(isMac
       ? [
-        {
+          {
-          label: 'Ontime',
+            label: 'Ontime',
-          submenu: [
+            submenu: [
-            { role: 'about' },
+              { role: 'about' },
-            { type: 'separator' },
+              { type: 'separator' },
-            { role: 'hide' },
+              { role: 'hide' },
-            { role: 'hideOthers' },
+              { role: 'hideOthers' },
-            { role: 'unhide' },
+              { role: 'unhide' },
-            { type: 'separator' },
+              { type: 'separator' },
-            {
+              {
-              label: 'quit',
+                label: 'quit',
-              click: () => askToQuit(),
+                click: () => askToQuit(),
-              accelerator: 'Cmd+Q',
+                accelerator: 'Cmd+Q',
-            },
+              },
-          ],
+            ],
-        },
+          },
-      ]
+        ]
       : []),
     {
       label: 'File',
@@ -41,15 +41,15 @@ function getApplicationMenu(isMac, askToQuit) {
         { role: 'paste' },
         ...(isMac
           ? [
-            { role: 'pasteAndMatchStyle' },
+              { role: 'pasteAndMatchStyle' },
-            { role: 'delete' },
+              { role: 'delete' },
-            { role: 'selectAll' },
+              { role: 'selectAll' },
-            { type: 'separator' },
+              { type: 'separator' },
-            {
+              {
-              label: 'Speech',
+                label: 'Speech',
-              submenu: [{ role: 'startSpeaking' }, { role: 'stopSpeaking' }],
+                submenu: [{ role: 'startSpeaking' }, { role: 'stopSpeaking' }],
-            },
+              },
-          ]
+            ]
           : [{ role: 'delete' }, { type: 'separator' }, { role: 'selectAll' }]),
       ],
     },
@@ -161,4 +161,4 @@ function getApplicationMenu(isMac, askToQuit) {
   ];
 }
 
-module.exports = { getApplicationMenu }
+module.exports = { getApplicationMenu };

apps/electron/src/menu/trayMenu.js

@@ -13,7 +13,7 @@ function getTrayMenu(showApp, askToQuit) {
       label: 'Shutdown',
       click: () => askToQuit(),
     },
-  ]
+  ];
 }
 
-module.exports = { getTrayMenu }
+module.exports = { getTrayMenu };

apps/server/.eslintrc

@@ -2,23 +2,11 @@
   "env": {
     "node": true
   },
-  "parser": "@typescript-eslint/parser",
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier"
-  ],
-  "plugins": ["@typescript-eslint", "prettier"],
   "parserOptions": {
     "ecmaVersion": 2020,
     "sourceType": "module"
   },
-  "rules": {
+  "globals": {
-    "prettier/prettier": [
+    "globalThis": false
-      "error",
-      {
-        "endOfLine": "auto"
-      }
-    ]
   }
 }

apps/server/.prettierrc

@@ -1,7 +1,8 @@
 {
-  "semi": true,
+  "endOfLine": "lf",
   "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
   "singleQuote": true,
-  "printWidth": 120,
+  "printWidth": 120
-  "tabWidth": 2
 }

apps/server/package.json

@@ -2,7 +2,7 @@
   "name": "ontime-server",
   "type": "module",
   "main": "src/index.ts",
-  "version": "2.9.0",
+  "version": "2.16.2",
   "exports": "./src/index.js",
   "dependencies": {
     "body-parser": "^1.20.0",
@@ -14,29 +14,30 @@
     "express-validator": "^6.14.2",
     "lowdb": "^5.0.5",
     "multer": "^1.4.5-lts.1",
-    "node-osc": "^8.0.10",
+    "node-osc": "^9.0.2",
-    "node-xlsx": "^0.21.0",
+    "node-xlsx": "^0.23.0",
     "ontime-utils": "workspace:*",
     "passport": "^0.6.0",
     "passport-local": "~1.0.0",
+    "steno": "^3.1.0",
     "ws": "^8.13.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^16.11.7",
-    "@types/node-osc": "^6.0.0",
+    "@types/node-osc": "^6.0.2",
     "@types/websocket": "^1.0.5",
-    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^5.48.1",
+    "@typescript-eslint/parser": "^6.10.0",
     "esbuild": "^0.17.5",
-    "eslint": "^8.31.0",
+    "eslint": "^8.53.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.0.1",
     "nodemon": "^2.0.20",
     "ontime-types": "workspace:*",
-    "prettier": "^2.8.3",
+    "prettier": "^3.0.3",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4",
+    "typescript": "^5.2.2",
     "vitest": "^0.30.1"
   },
   "scripts": {
@@ -51,9 +52,9 @@
     "build:local": "pnpm prebuild && esbuild src/index.ts --log-level=error --platform=node --format=cjs --bundle --minify --outfile=dist/index.cjs",
     "build:docker": "pnpm prebuild && esbuild src/index.ts --log-level=error --platform=node --format=cjs --minify --bundle --outfile=dist/docker.cjs",
     "build:debug": "pnpm prebuild && esbuild src/app.ts --platform=node --format=cjs --bundle --outfile=dist/index.cjs",
-    "lint": "eslint .",
+    "lint": "eslint . --quiet",
-    "test": "vitest",
+    "test": "cross-env IS_TEST=true vitest",
-    "test:pipeline": "vitest run",
+    "test:pipeline": "cross-env IS_TEST=true vitest run",
     "typecheck": "tsc --noEmit",
     "cleanup": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
   }

apps/server/src/adapters/OscAdapter.ts

@@ -12,16 +12,16 @@ export class OscServer implements IAdapter {
   constructor(config: OSCSettings) {
     this.osc = new Server(config.portIn, '0.0.0.0');
 
-    this.osc.on('error', console.error);
+    this.osc.on('error', (error) => logger.error(LogOrigin.Rx, `OSC IN: ${error}`));
 
     this.osc.on('message', (msg) => {
-      // message should look like /ontime/{path} {args} where
+      // message should look like /ontime/{path}/{params?} {args} where
       // ontime: fixed message for app
       // path: command to be called
       // args: extra data, only used on some API entries (delay, goto)
 
       // split message
-      const [, address, path] = msg[0].split('/');
+      const [, address, path, ...params] = msg[0].split('/');
       const args = msg[1];
 
       // get first part before (ontime)
@@ -37,7 +37,14 @@ export class OscServer implements IAdapter {
       }
 
       try {
-        const reply = dispatchFromAdapter(path, args, 'osc');
+        const reply = dispatchFromAdapter(
+          path,
+          {
+            payload: args,
+            params,
+          },
+          'osc',
+        );
         if (reply) {
           const { topic, payload } = reply;
           this.osc.emit(topic, payload);

apps/server/src/adapters/WebsocketAdapter.ts

@@ -123,7 +123,13 @@ export class SocketServer implements IAdapter {
 
           // Protocol specific stuff handled above
           try {
-            const reply = dispatchFromAdapter(type, payload, 'ws');
+            const reply = dispatchFromAdapter(
+              type,
+              {
+                payload,
+              },
+              'ws',
+            );
             if (reply) {
               const { topic, payload } = reply;
               ws.send(topic, payload);

apps/server/src/adapters/websocketAux.ts

@@ -4,7 +4,7 @@ import { socket } from './WebsocketAdapter.js';
  * Utility function to notify clients that the REST data is stale
  * @param payload -- possible patch payload
  */
-export function sendRefetch(payload: any | null = null) {
+export function sendRefetch(payload: unknown = null) {
   socket.sendAsJson({
     type: 'ontime-refetch',
     payload,

apps/server/src/app.ts

@@ -1,3 +1,5 @@
+import { LogOrigin, OSCSettings } from 'ontime-types';
+
 import 'dotenv/config';
 import express from 'express';
 import expressStaticGzip from 'express-static-gzip';
@@ -6,10 +8,8 @@ import cors from 'cors';
 
 // import utils
 import { join, resolve } from 'path';
-
 import { currentDirectory, environment, externalsStartDirectory, isProduction, resolvedPath } from './setup.js';
 import { ONTIME_VERSION } from './ONTIME_VERSION.js';
-import { LogOrigin, OSCSettings } from 'ontime-types';
 
 // Import Routes
 import { router as rundownRouter } from './routes/rundownRouter.js';
@@ -31,6 +31,8 @@ import { logger } from './classes/Logger.js';
 import { oscIntegration } from './services/integration-service/OscIntegration.js';
 import { populateStyles } from './modules/loadStyles.js';
 import { eventStore, getInitialPayload } from './stores/EventStore.js';
+import { PlaybackService } from './services/PlaybackService.js';
+import { RestorePoint, restoreService } from './services/RestoreService.js';
 
 console.log(`Starting Ontime version ${ONTIME_VERSION}`);
 
@@ -137,10 +139,21 @@ export const startServer = async () => {
   expressServer = http.createServer(app);
 
   socket.init(expressServer);
+  eventLoader.init();
+
+  // load restore point if it exists
+  const maybeRestorePoint = restoreService.load();
+
+  if (maybeRestorePoint) {
+    logger.info(LogOrigin.Server, 'Found resumable state');
+    PlaybackService.resume(maybeRestorePoint);
+  }
+
+  eventTimer.setRestoreCallback(async (newState: RestorePoint) => restoreService.save(newState));
 
   // provide initial payload to event store
-  eventLoader.init();
+  const initialPayload = getInitialPayload();
-  eventStore.init(getInitialPayload());
+  eventStore.init(initialPayload);
 
   expressServer.listen(serverPort, '0.0.0.0');
 
@@ -187,7 +200,7 @@ export const startIntegrations = async (config?: { osc: OSCSettings }) => {
   }
 
   const { success, message } = oscIntegration.init(osc);
-  logger.info(LogOrigin.Rx, message);
+  logger.info(LogOrigin.Tx, message);
 
   if (success) {
     integrationService.register(oscIntegration);
@@ -202,6 +215,14 @@ export const startIntegrations = async (config?: { osc: OSCSettings }) => {
 export const shutdown = async (exitCode = 0) => {
   console.log(`Ontime shutting down with code ${exitCode}`);
 
+  // clear the restore file if it was a normal exit
+  // 0 means it was a SIGNAL
+  // 1 means crash -> keep the file
+  // 99 means it was the UI
+  if (exitCode === 0 || exitCode === 99) {
+    await restoreService.clear();
+  }
+
   expressServer?.close();
   oscServer?.shutdown();
   eventTimer.shutdown();