refactor: organise API around resources (#798)

apps/server/src/api-data/custom-fields/customFields.controller.ts

@@ -0,0 +1,49 @@
+import { CustomField, CustomFields } from 'ontime-types';
+
+import type { Request, Response } from 'express';
+
+import {
+  createCustomField,
+  editCustomField,
+  getCustomFields as getCustomFieldsFromCache,
+  removeCustomField,
+} from '../../services/rundown-service/rundownCache.js';
+
+export async function getCustomFields(_req: Request, res: Response<CustomFields>) {
+  const customFields = getCustomFieldsFromCache();
+  res.json(customFields);
+}
+
+// Expects { label: <label> type: 'string | ..' }
+export async function postCustomField(req: Request, res: Response) {
+  try {
+    const newField = req.body as CustomField;
+    const allFields = await createCustomField(newField);
+    res.status(201).send(allFields);
+  } catch (error) {
+    res.status(400).send({ message: error.toString() });
+  }
+}
+
+// Expects { label: <oldLabel>, field: { label: <newLabel> type: 'string | ..' } }
+export async function putCustomField(req: Request, res: Response) {
+  try {
+    const oldLabel = req.params.label;
+    const { colour, type, label } = req.body;
+    const newFields = await editCustomField(oldLabel, { label, colour, type });
+    res.status(200).send(newFields);
+  } catch (error) {
+    res.status(400).send({ message: error.toString() });
+  }
+}
+
+// Expects { label: <label> }
+export async function deleteCustomField(req: Request, res: Response) {
+  try {
+    const fieldToDelete = req.params.label;
+    await removeCustomField(fieldToDelete);
+    res.sendStatus(204);
+  } catch (error) {
+    res.status(400).send({ message: error.toString() });
+  }
+}

apps/server/src/api-data/custom-fields/customFields.router.ts

@@ -0,0 +1,14 @@
+import express from 'express';
+
+import { deleteCustomField, getCustomFields, postCustomField, putCustomField } from './customFields.controller.js';
+import { validateCustomField, validateDeleteCustomField, validateEditCustomField } from './customFields.validation.js';
+
+export const router = express.Router();
+
+router.get('/', getCustomFields);
+
+router.post('/', validateCustomField, postCustomField);
+
+router.put('/:label', validateEditCustomField, putCustomField);
+
+router.delete('/:label', validateDeleteCustomField, deleteCustomField);

apps/server/src/api-data/custom-fields/customFields.validation.ts

@@ -0,0 +1,45 @@
+import { isAlphanumeric } from 'ontime-utils';
+
+import { Request, Response, NextFunction } from 'express';
+import { body, param, validationResult } from 'express-validator';
+
+export const validateCustomField = [
+  body('label')
+    .exists()
+    .isString()
+    .trim()
+    .custom((value) => {
+      return isAlphanumeric(value);
+    }),
+  body('type').exists().isString().trim(),
+  body('colour').exists().isString().trim(),
+
+  (req: Request, res: Response, next: NextFunction) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];
+
+export const validateEditCustomField = [
+  param('label').exists().isString().trim(),
+  body('label').exists().isString().trim(),
+  body('type').exists().isString().trim(),
+  body('colour').exists().isString().trim(),
+
+  (req: Request, res: Response, next: NextFunction) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];
+
+export const validateDeleteCustomField = [
+  param('label').exists().isString(),
+
+  (req: Request, res: Response, next: NextFunction) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];