feat: quick project wizard

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

@@ -1,4 +1,4 @@
-import { DatabaseModel, ErrorResponse, MessageResponse, ProjectData, ProjectFileListResponse } from 'ontime-types';
+import { DatabaseModel, ErrorResponse, MessageResponse, ProjectFileListResponse } from 'ontime-types';
 import { getErrorMessage } from 'ontime-utils';
 
 import type { Request, Response } from 'express';
@@ -30,17 +30,17 @@ export async function patchPartialProjectFile(req: Request, res: Response<Databa
  *                         or a 500 status with an error message in case of an exception.
  */
 export async function createProjectFile(req: Request, res: Response<{ filename: string } | ErrorResponse>) {
-  const newProjectData: ProjectData = {
-    title: req.body?.title ?? '',
-    description: req.body?.description ?? '',
-    publicUrl: req.body?.publicUrl ?? '',
-    publicInfo: req.body?.publicInfo ?? '',
-    backstageUrl: req.body?.backstageUrl ?? '',
-    backstageInfo: req.body?.backstageInfo ?? '',
-  };
-
   try {
-    const newFileName = await projectService.createProject(req.body.filename, newProjectData);
+    const newFileName = await projectService.createProject(req.body.filename, {
+      project: {
+        title: req.body?.title ?? '',
+        description: req.body?.description ?? '',
+        publicUrl: req.body?.publicUrl ?? '',
+        publicInfo: req.body?.publicInfo ?? '',
+        backstageUrl: req.body?.backstageUrl ?? '',
+        backstageInfo: req.body?.backstageInfo ?? '',
+      },
+    });
 
     res.status(200).send({
       filename: newFileName,
@@ -51,6 +51,21 @@ export async function createProjectFile(req: Request, res: Response<{ filename:
   }
 }
 
+/**
+ * Creates and loads a new project with partial DataBase data
+ */
+export async function quickProjectFile(req: Request, res: Response<{ filename: string } | ErrorResponse>) {
+  try {
+    const filename = await projectService.createProject(req.body.project.title, req.body);
+    res.status(200).send({
+      filename,
+    });
+  } catch (error) {
+    const message = getErrorMessage(error);
+    res.status(500).send({ message });
+  }
+}
+
 /**
  * Allows downloading of current project file
  */

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

@@ -10,6 +10,7 @@ import {
   patchPartialProjectFile,
   postProjectFile,
   projectDownload,
+  quickProjectFile,
   renameProjectFile,
 } from './db.controller.js';
 import { uploadProjectFile } from './db.middleware.js';
@@ -19,6 +20,7 @@ import {
   validateFilenameBody,
   validateFilenameParam,
   validateNewFilenameBody,
+  validateQuickProject,
 } from './db.validation.js';
 
 export const router = express.Router();
@@ -29,6 +31,7 @@ router.post('/upload', uploadProjectFile, postProjectFile);
 
 router.patch('/', validatePatchProject, patchPartialProjectFile);
 router.post('/new', validateFilenameBody, validateNewProject, createProjectFile);
+router.post('/quick', validateQuickProject, quickProjectFile);
 
 router.get('/all', listProjects);
 

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

@@ -22,6 +22,28 @@ export const validateNewProject = [
   },
 ];
 
+/**
+ * @description Validates request for a quick project.
+ */
+export const validateQuickProject = [
+  // Project fields
+  body('project.title').isString().trim(),
+
+  // Settings fields
+  body('settings.timeFormat').optional().isIn(['12', '24']),
+  body('settings.language').optional().isString().trim(),
+
+  // ViewSettings fields
+  body('viewSettings.freezeEnd').optional().isBoolean(),
+  body('viewSettings.endMessage').optional().isString().trim(),
+
+  (req: Request, res: Response, next: NextFunction) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];
+
 /**
  * @description Validates request for pathing data in the project.
  */

apps/server/src/classes/data-provider/DataProvider.utils.ts

@@ -4,11 +4,20 @@ import { DatabaseModel } from 'ontime-types';
  * Merges a partial ontime project into a given ontime project
  */
 export function safeMerge(existing: DatabaseModel, newData: Partial<DatabaseModel>): DatabaseModel {
-  const { rundown, project, settings, viewSettings, urlPresets, customFields, osc, http } = newData || {};
+  const {
+    rundown = existing.rundown,
+    project = {},
+    settings = {},
+    viewSettings = {},
+    urlPresets = existing.urlPresets,
+    customFields = existing.customFields,
+    osc = {},
+    http = {},
+  } = newData;
 
   return {
     ...existing,
-    rundown: rundown ?? existing.rundown,
+    rundown,
     project: { ...existing.project, ...project },
     settings: { ...existing.settings, ...settings },
     viewSettings: { ...existing.viewSettings, ...viewSettings },

apps/server/src/services/project-service/ProjectService.ts

@@ -1,4 +1,4 @@
-import { DatabaseModel, LogOrigin, ProjectData, ProjectFileListResponse } from 'ontime-types';
+import { DatabaseModel, LogOrigin, ProjectFileListResponse } from 'ontime-types';
 import { getErrorMessage } from 'ontime-utils';
 
 import { copyFile, rename } from 'fs/promises';
@@ -38,6 +38,7 @@ import {
   moveCorruptFile,
   parseJsonFile,
 } from './projectServiceUtils.js';
+import { safeMerge } from '../../classes/data-provider/DataProvider.utils.js';
 
 // init dependencies
 init();
@@ -263,14 +264,8 @@ export async function renameProjectFile(originalFile: string, newFilename: strin
 /**
  * Creates a new project file and applies its result
  */
-export async function createProject(filename: string, projectData: ProjectData) {
-  const data: DatabaseModel = {
-    ...dbModel,
-    project: {
-      ...dbModel.project,
-      ...projectData,
-    },
-  };
+export async function createProject(filename: string, initialData: Partial<DatabaseModel>) {
+  const data = safeMerge(dbModel, initialData);
 
   const uniqueFileName = generateUniqueFileName(publicDir.projectsDir, filename);
   const newFile = getPathToProject(uniqueFileName);