refactor: migrate custom fields to transactions

refactor: extract functions to api domain

refactor: strict custom field parsing

refactor: remove rundown cache utilities

refactor: directory restructure

apps/server/src/api-data/project-data/__tests__/projectData.parser.test.ts

@@ -0,0 +1,10 @@
+import { parseProjectData } from '../projectData.parser.js';
+
+describe('parseProjectData()', () => {
+  it('returns an a base model if nothing is given', () => {
+    const errorEmitter = vi.fn();
+    const result = parseProjectData({}, errorEmitter);
+    expect(result).toBeTypeOf('object');
+    expect(errorEmitter).toHaveBeenCalledOnce();
+  });
+});

apps/server/src/api-data/project-data/projectData.controller.ts

@@ -0,0 +1,40 @@
+import { ErrorResponse, ProjectData } from 'ontime-types';
+import { getErrorMessage } from 'ontime-utils';
+
+import type { Request, Response } from 'express';
+
+import { removeUndefined } from '../../utils/parserUtils.js';
+import { failEmptyObjects } from '../../utils/routerUtils.js';
+import { editCurrentProjectData } from '../../services/project-service/ProjectService.js';
+import * as projectDao from './projectData.dao.js';
+
+export function getProjectData(_req: Request, res: Response<ProjectData>) {
+  res.json(projectDao.getProjectData());
+}
+
+export async function postProjectData(req: Request, res: Response<ProjectData | ErrorResponse>) {
+  if (failEmptyObjects(req.body, res)) {
+    return;
+  }
+
+  try {
+    const newData: Partial<ProjectData> = removeUndefined({
+      title: req.body?.title,
+      description: req.body?.description,
+      publicUrl: req.body?.publicUrl,
+      publicInfo: req.body?.publicInfo,
+      backstageUrl: req.body?.backstageUrl,
+      backstageInfo: req.body?.backstageInfo,
+      endMessage: req.body?.endMessage,
+      projectLogo: req.body?.projectLogo,
+      custom: req.body?.custom,
+    });
+
+    const updatedData = await editCurrentProjectData(newData);
+
+    res.status(200).send(updatedData);
+  } catch (error) {
+    const message = getErrorMessage(error);
+    res.status(400).send({ message });
+  }
+}

apps/server/src/api-data/project-data/projectData.dao.ts

@@ -0,0 +1,10 @@
+import { ProjectData } from 'ontime-types';
+
+import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
+
+/**
+ * Gets a copy of the stored project data
+ */
+export function getProjectData(): ProjectData {
+  return structuredClone(getDataProvider().getProjectData());
+}

apps/server/src/api-data/project-data/projectData.parser.ts

@@ -0,0 +1,27 @@
+import { DatabaseModel, ProjectData } from 'ontime-types';
+
+import { dbModel } from '../../models/dataModel.js';
+import { ErrorEmitter } from '../../utils/parserUtils.js';
+
+/**
+ * Parse event portion of an entry
+ */
+export function parseProjectData(data: Partial<DatabaseModel>, emitError?: ErrorEmitter): ProjectData {
+  if (!data.project) {
+    emitError?.('No data found to import');
+    return { ...dbModel.project };
+  }
+
+  console.log('Found project data, importing...');
+
+  return {
+    title: data.project.title ?? dbModel.project.title,
+    description: data.project.description ?? dbModel.project.description,
+    publicUrl: data.project.publicUrl ?? dbModel.project.publicUrl,
+    publicInfo: data.project.publicInfo ?? dbModel.project.publicInfo,
+    backstageUrl: data.project.backstageUrl ?? dbModel.project.backstageUrl,
+    backstageInfo: data.project.backstageInfo ?? dbModel.project.backstageInfo,
+    projectLogo: data.project.projectLogo ?? dbModel.project.projectLogo,
+    custom: data.project.custom ?? dbModel.project.custom,
+  };
+}

apps/server/src/api-data/project-data/projectData.router.ts

@@ -0,0 +1,12 @@
+import express from 'express';
+
+import { getProjectData, postProjectData } from './projectData.controller.js';
+import { projectSanitiser } from './projectData.validation.js';
+import { uploadImageFile } from '../db/db.middleware.js';
+import { postProjectLogo } from '../db/db.controller.js';
+
+export const router = express.Router();
+
+router.get('/', getProjectData);
+router.post('/', projectSanitiser, postProjectData);
+router.post('/upload', uploadImageFile, postProjectLogo);

apps/server/src/api-data/project-data/projectData.validation.ts

@@ -0,0 +1,22 @@
+import { Request, Response, NextFunction } from 'express';
+import { body, validationResult } from 'express-validator';
+
+export const projectSanitiser = [
+  body('title').optional().isString().trim(),
+  body('description').optional().isString().trim(),
+  body('publicUrl').optional().isString().trim(),
+  body('publicInfo').optional().isString().trim(),
+  body('backstageUrl').optional().isString().trim(),
+  body('backstageInfo').optional().isString().trim(),
+  body('endMessage').optional().isString().trim(),
+  body('projectLogo').optional({ nullable: true }).isString().trim(),
+  body('custom').optional().isArray(),
+  body('custom.*.title').optional().isString().trim().notEmpty(),
+  body('custom.*.value').optional().isString().trim().notEmpty(),
+
+  (req: Request, res: Response, next: NextFunction) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];