V3 (#657)

* refactor: cleanup routes

* style: smaller base font

* chore: upgrade dependencies

* chore: lock node version to electron

* refactor: pass HTTP to integration controller (#652)

* refactor: deprecate onair control

* refactor: remove playback router

* Several project files user folder (#617)

* chore: automated screenshots (#667)

* feat: app settings (#658)

* refactor: remove deprecated event data (#674)

* Studio clock (#663)

---------

Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* Feat: reorder events with alt+ctrl + arrow up/down (#645)

* Warning and danger per event (#677)

---------

Co-authored-by: Fabian Posenau <fabian@fphome.de>

* refactor: stabilise actionHandler (#683)

Co-authored-by: Fabian Posenau <fabian@fphome.de>

* improvement: hide seconds (#675)

* wip: overview (#688)

* fix: focus cursor (#695)

* refactor: update lower third (#665)

* Refactor/time formatting (#696)

---------

Co-authored-by: Carlos Valente <34649812+cpvalente@users.noreply.github.com>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* feat: multiple selection (#703)

---------

Co-authored-by: asharonbaltazar <asharonbaltazar@outlook.com>
Co-authored-by: Alex <ac@omnivox.dk>

* fix: test - go to `Edit mode` befor tying to click `Event options` button (#708)

* refactor: runtime service (#715)

* fix: issue with loosing cursor position on message (#719)

* remove info panel (#721)

* Event editor continue (#722)

* update API - part  (#709)

---------

Co-authored-by: Carlos Valente <34649812+cpvalente@users.noreply.github.com>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* refactor: update timers (#729)

* feat: many timers (#706)

---------

Co-authored-by: arc-alex <ac@omnivox.dk>

* refactor: excel cleanup (#734)

* refactor: allow import of blocks and skip import (#735)

* Project manager (#697)

* refactor: UI for linking events (#763)

* upgraded pipeline actions (#777)

* Over under (#771)

* custom fields (#744)


---------

Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* Sheets settings (#774)

---------

Co-authored-by: arc-alex <ac@omnivox.dk>

* style: tweaks to lower thirds (#785)

* refactor: delays account for gaps (#784)

* refactor: partial state updates (#780)

* feat: generate crash report (#787)

* Sheet use limited input device auth flow (#782)

---------

Co-authored-by: cv <34649812+cpvalente@users.noreply.github.com>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* Custom fields views (#789)

* refactor: deprecate presenter and subtitle (#795)

* refactor: organise API around resources (#798)

---------

Co-authored-by: Bianca Procopio <biancahprocopio@gmail.com>

* Time to end (#804)

* Skip fixes (#805)

* fix: onair derives from playback

* Param nav (#822)

---------

Co-authored-by: Alex Christoffer Rasmussen <ac@omnivox.dk>

* refactor: download files from interface (#831)

* Quick options (#814)

* End pause (#832)

* chore: bump node version in docker (#834)

* refactor: follow in run mode (#840)

* fix: uncaught error in http integration (#837)

* Apply project (#843)

Co-authored-by: Matteo Gheza <matteo.gheza07@gmail.com>
Co-authored-by: Ary <arylmoraesn@gmail.com>
Co-authored-by: Alex Christoffer Rasmussen <ac@omnivox.dk>
Co-authored-by: Fabian Posenau <19673098+kellhogs@users.noreply.github.com>
Co-authored-by: Fabian Posenau <fabian@fphome.de>
Co-authored-by: Alex Rohleder <alexrohleder96@gmail.com>
Co-authored-by: asharonbaltazar <asharonbaltazar@outlook.com>
Co-authored-by: Bianca Procopio <biancahprocopio@gmail.com>
Co-authored-by: Fabian Posenau <fabianpos99+github@gmail.com>

apps/server/src/api-data/excel/excel.controller.ts

@@ -0,0 +1,40 @@
+/**
+ * This module encapsulates logic related to
+ * Google Sheets
+ */
+
+import { Request, Response } from 'express';
+import { generateRundownPreview, listWorksheets, saveExcelFile } from './excel.service.js';
+
+export async function postExcel(req: Request, res: Response) {
+  try {
+    const filePath = req.file.path;
+    await saveExcelFile(filePath);
+    res.status(200).send();
+  } catch (error) {
+    res.status(500).send({ message: String(error) });
+  }
+}
+
+export async function getWorksheets(req: Request, res: Response) {
+  try {
+    const names = listWorksheets();
+    res.status(200).send(names);
+  } catch (error) {
+    res.status(500).send({ message: String(error) });
+  }
+}
+
+/**
+ * parses an Excel spreadsheet
+ * @returns parsed result
+ */
+export async function previewExcel(req: Request, res: Response) {
+  try {
+    const { options } = req.body;
+    const data = generateRundownPreview(options);
+    res.status(200).send(data);
+  } catch (error) {
+    res.status(500).send({ message: String(error) });
+  }
+}

apps/server/src/api-data/excel/excel.middleware.ts

@@ -0,0 +1,17 @@
+import { Request } from 'express';
+import multer, { FileFilterCallback } from 'multer';
+
+import { EXCEL_MIME } from '../../utils/parser.js';
+import { storage } from '../../utils/upload.js';
+
+const filterExcel = (_req: Request, file: Express.Multer.File, cb: FileFilterCallback) => {
+  if (file.mimetype.includes(EXCEL_MIME)) {
+    cb(null, true);
+  } else {
+    cb(null, false);
+  }
+};
+export const uploadExcel = multer({
+  storage,
+  fileFilter: filterExcel,
+}).single('excel');

apps/server/src/api-data/excel/excel.router.ts

@@ -0,0 +1,16 @@
+/**
+ * This is a feature specific router for integration with Excel
+ */
+
+import express from 'express';
+import { uploadExcel } from './excel.middleware.js';
+import { getWorksheets, postExcel, previewExcel } from './excel.controller.js';
+import { validateFileExists, validateImportMapOptions } from './excel.validation.js';
+
+export const router = express.Router();
+
+router.post('/upload', uploadExcel, validateFileExists, postExcel);
+router.get('/worksheets', getWorksheets);
+router.post('/preview', validateImportMapOptions, previewExcel);
+
+// TODO: validate import map

apps/server/src/api-data/excel/excel.service.ts

@@ -0,0 +1,55 @@
+/**
+ * This module encapsulates logic related to
+ * Google Sheets
+ */
+
+import { CustomFields, OntimeRundown } from 'ontime-types';
+import { ImportMap } from 'ontime-utils';
+
+import { extname } from 'path';
+import { existsSync } from 'fs';
+import xlsx from 'node-xlsx';
+
+import { parseExcel } from '../../utils/parser.js';
+import { parseCustomFields, parseRundown } from '../../utils/parserFunctions.js';
+import { deleteFile } from '../../utils/parserUtils.js';
+
+let excelData: { name: string; data: unknown[][] }[] = [];
+
+export async function saveExcelFile(filePath: string) {
+  if (!existsSync(filePath)) {
+    throw new Error('Upload of excel file failed');
+  }
+  if (extname(filePath) != '.xlsx') {
+    throw new Error('Wrong file format');
+  }
+  excelData = xlsx.parse(filePath, { cellDates: true });
+
+  await deleteFile(filePath);
+}
+
+export function listWorksheets() {
+  return excelData.map((value) => value.name);
+}
+
+export function generateRundownPreview(options: ImportMap): { rundown: OntimeRundown; customFields: CustomFields } {
+  const data = excelData.find(({ name }) => name.toLowerCase() === options.worksheet.toLowerCase())?.data;
+
+  if (!data) {
+    throw new Error(`Could not find data to import, maybe the worksheet name is incorrect: ${options.worksheet}`);
+  }
+
+  const dataFromExcel = parseExcel(data, options);
+
+  // we run the parsed data through an extra step to ensure the objects shape
+  const rundown = parseRundown(dataFromExcel);
+  if (rundown.length === 0) {
+    throw new Error(`Could not find data to import in the worksheet: ${options.worksheet}`);
+  }
+  const customFields = parseCustomFields(dataFromExcel);
+
+  // clear the data
+  excelData = [];
+
+  return { rundown, customFields };
+}

apps/server/src/api-data/excel/excel.validation.ts

@@ -0,0 +1,28 @@
+import { isImportMap } from 'ontime-utils';
+
+import { body, validationResult } from 'express-validator';
+import { NextFunction, Request, Response } from 'express';
+
+export const validateFileExists = [
+  (req: Request, res: Response, next: NextFunction) => {
+    if (!req.file) {
+      return res.status(422).json({ errors: 'File not found' });
+    }
+    next();
+  },
+];
+
+export const validateImportMapOptions = [
+  body('options')
+    .exists()
+    .isObject()
+    .custom((content) => {
+      return isImportMap(content);
+    }),
+
+  (req: Request, res: Response, next: NextFunction) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];