refactor: add rundown summary to import preview

This commit is contained in:
Carlos Valente
2025-11-02 12:46:26 +01:00
committed by Carlos Valente
parent 3918664945
commit e6070e6efd
12 changed files with 103 additions and 35 deletions
@@ -1,6 +1,6 @@
import express from 'express';
import type { Request, Response } from 'express';
import { CustomFields, ErrorResponse, Rundown } from 'ontime-types';
import { CustomFields, ErrorResponse, Rundown, RundownSummary } from 'ontime-types';
import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
@@ -32,7 +32,10 @@ router.post(
router.post(
'/preview',
validateImportMapOptions,
(req: Request, res: Response<{ rundown: Rundown; customFields: CustomFields } | ErrorResponse>) => {
(
req: Request,
res: Response<{ rundown: Rundown; customFields: CustomFields; summary: RundownSummary } | ErrorResponse>,
) => {
try {
const { options } = req.body;
const data = generateRundownPreview(options);
@@ -3,7 +3,7 @@
* Google Sheets
*/
import { CustomFields, Rundown } from 'ontime-types';
import { CustomFields, Rundown, RundownSummary } from 'ontime-types';
import { type ImportMap } from 'ontime-utils';
import { extname } from 'path';
@@ -14,7 +14,7 @@ import type { WorkBook } from 'xlsx';
import { deleteFile } from '../../utils/fileManagement.js';
import { parseRundown } from '../rundown/rundown.parser.js';
import { getProjectCustomFields } from '../rundown/rundown.dao.js';
import { getProjectCustomFields, processRundown } from '../rundown/rundown.dao.js';
import { parseCustomFields } from '../custom-fields/customFields.parser.js';
import { parseExcel } from './excel.parser.js';
@@ -43,7 +43,11 @@ export async function readExcelFile(filePath: string): Promise<string[]> {
return excelData.SheetNames;
}
export function generateRundownPreview(options: ImportMap): { rundown: Rundown; customFields: CustomFields } {
export function generateRundownPreview(options: ImportMap): {
rundown: Rundown;
summary: RundownSummary;
customFields: CustomFields;
} {
const data = excelData.Sheets[options.worksheet];
if (!data) {
@@ -59,9 +63,25 @@ export function generateRundownPreview(options: ImportMap): { rundown: Rundown;
// we run the parsed data through an extra step to ensure the objects shape
const customFields = parseCustomFields(dataFromExcel);
const rundown = parseRundown(dataFromExcel.rundown, customFields);
const parsedRundown = parseRundown(dataFromExcel.rundown, customFields);
const processedRundown = processRundown(parsedRundown, customFields);
return { rundown, customFields };
return {
rundown: {
id: parsedRundown.id,
title: parsedRundown.title,
order: processedRundown.order,
flatOrder: processedRundown.flatEntryOrder,
entries: processedRundown.entries,
revision: 0,
},
summary: {
duration: processedRundown.totalDuration,
start: processedRundown.firstStart,
end: processedRundown.lastEnd,
},
customFields,
};
}
/**
@@ -3,7 +3,7 @@
* Google Sheets
*/
import type { AuthenticationStatus, CustomFields, ErrorResponse, Rundown } from 'ontime-types';
import type { AuthenticationStatus, CustomFields, ErrorResponse, Rundown, RundownSummary } from 'ontime-types';
import { getErrorMessage } from 'ontime-utils';
import { Request, Response } from 'express';
@@ -86,6 +86,7 @@ export async function readFromSheet(
| {
rundown: Rundown;
customFields: CustomFields;
summary: RundownSummary;
}
| ErrorResponse
>,